Skip to content

@shtse8/fluxus v1.0.0


@shtse8/fluxus / src / Scope

Class: Scope

Defined in: src/scope.ts:106

Manages the state and lifecycle of providers within a specific context.

Implements

Implements

Constructors

Constructor

new Scope(_parent, overrides): Scope

Defined in: src/scope.ts:116

Parameters

_parent

null | Scope

overrides

readonly ProviderOverride[] = []

Returns

Scope

Accessors

isDisposed

Get Signature

get isDisposed(): boolean

Defined in: src/scope.ts:112

Returns

boolean

Methods

dispose()

dispose(): void

Defined in: src/scope.ts:750

Disposes of the resource or ends the lifecycle managed by this object. Calling dispose multiple times should be safe (idempotent).

Returns

void

Implementation of

Disposable.dispose


read()

read<T>(provider): T

Defined in: src/scope.ts:160

Type Parameters

T

T

Parameters

provider

Provider<T>

Returns

T


updater()

updater<T>(provider): StateUpdater<T>

Defined in: src/scope.ts:612

Retrieves the updater function for a StateProviderInstance.

Type Parameters

T

T

Parameters

provider

StateProviderInstance<T>

Returns

StateUpdater<T>


watch()

watch<T>(provider, callback): Dispose

Defined in: src/scope.ts:722

Subscribes a listener to a provider's state changes.

Type Parameters

T

T

Parameters

provider

Provider<T>

callback

() => void

Returns

Dispose

Released under the ISC License.