Skip to content

@epikodelabs/streamix


@epikodelabs/streamix / src/public-api / Scope

Interface: Scope()<T> ​

Defined in: projects/libraries/streamix/src/lib/atoms/scope.ts:469

Runtime scope instance.

A scope owns the atoms created from a definition object, exposes their current values as properties, and provides lifecycle cleanup through dispose.

Type Parameters ​

T ​

T extends Record<string, any> = Record<string, any>

Call Signature ​

Scope<A>(atom): ScopeAtomValue<A>

Defined in: projects/libraries/streamix/src/lib/atoms/scope.ts:470

Runtime scope instance.

A scope owns the atoms created from a definition object, exposes their current values as properties, and provides lifecycle cleanup through dispose.

Type Parameters ​

A ​

A extends Atom<any>

Parameters ​

atom ​

A

Returns ​

ScopeAtomValue<A>

Call Signature ​

Scope<A>(...atoms): { [K in string | number | symbol]: ScopeAtomValue<A[K]> }

Defined in: projects/libraries/streamix/src/lib/atoms/scope.ts:471

Runtime scope instance.

A scope owns the atoms created from a definition object, exposes their current values as properties, and provides lifecycle cleanup through dispose.

Type Parameters ​

A ​

A extends Atom<any>[]

Parameters ​

atoms ​

...A

Returns ​

{ [K in string | number | symbol]: ScopeAtomValue<A[K]> }

Properties ​

type ​

type: "scope"

Defined in: projects/libraries/streamix/src/lib/atoms/scope.ts:472


cleanups ​

cleanups: Set<() => void>

Defined in: projects/libraries/streamix/src/lib/atoms/scope.ts:473


parent ​

parent: Scope<Record<string, any>> | RootScope | null

Defined in: projects/libraries/streamix/src/lib/atoms/scope.ts:474


loading ​

readonly loading: boolean

Defined in: projects/libraries/streamix/src/lib/atoms/scope.ts:475


dirty ​

readonly dirty: boolean

Defined in: projects/libraries/streamix/src/lib/atoms/scope.ts:476


_pendingCount ​

_pendingCount: number

Defined in: projects/libraries/streamix/src/lib/atoms/scope.ts:479


_dirtyCount ​

_dirtyCount: number

Defined in: projects/libraries/streamix/src/lib/atoms/scope.ts:480


_exports ​

_exports: Set<string | symbol>

Defined in: projects/libraries/streamix/src/lib/atoms/scope.ts:481


_disposed ​

_disposed: boolean

Defined in: projects/libraries/streamix/src/lib/atoms/scope.ts:482


_rawState ​

_rawState: Record<string | symbol, any>

Defined in: projects/libraries/streamix/src/lib/atoms/scope.ts:483


_ownedAtoms ​

_ownedAtoms: Set<Atom<any> | Scope<Record<string, any>>>

Defined in: projects/libraries/streamix/src/lib/atoms/scope.ts:484

Methods ​

snapshot() ​

snapshot(): UnwrapSnapshotValues<T>

Defined in: projects/libraries/streamix/src/lib/atoms/scope.ts:477

Returns ​

UnwrapSnapshotValues<T>


dispose() ​

dispose(): void

Defined in: projects/libraries/streamix/src/lib/atoms/scope.ts:478

Returns ​

void

Released under the MIT License.