Skip to content

@shtse8/fluxus v1.0.0


@shtse8/fluxus / src / AsyncProviderInstance

Interface: AsyncProviderInstance()<T>

Defined in: src/providers/asyncProvider.ts:23

Represents an instance of an AsyncProvider. It acts as a Provider<AsyncValue<T>> for reading the async state. It carries metadata via a symbol to distinguish it during initialization.

Extends

Type Parameters

T

T

The type of the data produced by the async operation.

AsyncProviderInstance(reader): AsyncValue

Defined in: src/providers/asyncProvider.ts:23

Represents an instance of an AsyncProvider. It acts as a Provider<AsyncValue<T>> for reading the async state. It carries metadata via a symbol to distinguish it during initialization.

Parameters

reader

ScopeReader

Returns

AsyncValue

Properties

[$asyncProvider]

[$asyncProvider]: object

Defined in: src/providers/asyncProvider.ts:24

create()

create: (read) => Promise<T>

The asynchronous function that produces the value.

Parameters
read

ScopeReader

Returns

Promise<T>

options?

optional options: AsyncProviderOptions

Optional configuration for the provider.


type?

readonly optional type: "asyncProvider"

Defined in: src/providers/asyncProvider.ts:31

Released under the ISC License.