@epikodelabs/streamix / src/public-api / Scope
Interface: Scope()<T>
Defined in: projects/libraries/streamix/src/lib/atoms/scope.ts:420
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:421
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<K>]> }
Defined in: projects/libraries/streamix/src/lib/atoms/scope.ts:422
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<K>]> }
Properties
type
type:
"scope"
Defined in: projects/libraries/streamix/src/lib/atoms/scope.ts:423
atoms
atoms:
Set<Atom<any> |Scope<Record<string,any>>>
Defined in: projects/libraries/streamix/src/lib/atoms/scope.ts:424
cleanups
cleanups:
Set<() =>void>
Defined in: projects/libraries/streamix/src/lib/atoms/scope.ts:425
mode
mode:
"discrete"|"analog"
Defined in: projects/libraries/streamix/src/lib/atoms/scope.ts:426
parent
parent:
Scope<Record<string,any>> |RootScope|null
Defined in: projects/libraries/streamix/src/lib/atoms/scope.ts:427
container
container:
Container
Defined in: projects/libraries/streamix/src/lib/atoms/scope.ts:428
loading
readonlyloading:boolean
Defined in: projects/libraries/streamix/src/lib/atoms/scope.ts:429
dirty
readonlydirty:boolean
Defined in: projects/libraries/streamix/src/lib/atoms/scope.ts:430
_pendingCount
_pendingCount:
number
Defined in: projects/libraries/streamix/src/lib/atoms/scope.ts:433
_dirtyCount
_dirtyCount:
number
Defined in: projects/libraries/streamix/src/lib/atoms/scope.ts:434
_exports
_exports:
Set<string|symbol>
Defined in: projects/libraries/streamix/src/lib/atoms/scope.ts:435
_disposed
_disposed:
boolean
Defined in: projects/libraries/streamix/src/lib/atoms/scope.ts:436
_rawState
_rawState:
Record<string|symbol,any>
Defined in: projects/libraries/streamix/src/lib/atoms/scope.ts:437
Methods
snapshot()
snapshot():
UnwrapSnapshotValues<T>
Defined in: projects/libraries/streamix/src/lib/atoms/scope.ts:431
Returns
UnwrapSnapshotValues<T>
dispose()
dispose():
void
Defined in: projects/libraries/streamix/src/lib/atoms/scope.ts:432
Returns
void