Class State<Value>

State container that represents the asynchrony of a trackedFunction

Type Parameters

  • Value

Hierarchy

  • State

Constructors

constructor

Properties

error? isResolved resolvedValue?

Accessors

isError isLoading isPending value

Methods

retry

Constructors

constructor

  • Type Parameters

    Type Parameters

    • Value

    Parameters

    • fn: ResourceFn<Value>
    • hooks: Hooks
    • Optional initialValue: Value

    Returns State<Value>

Properties

Optional error

error?: unknown

isResolved

isResolved: boolean = false

Optional resolvedValue

resolvedValue?: Value

Accessors

isError

  • get isError(): boolean

  • Returns boolean

isLoading

  • get isLoading(): boolean

  • Returns boolean

isPending

  • get isPending(): boolean

  • Returns boolean

value

  • get value(): null | NonNullable<Value>

  • Returns null | NonNullable<Value>

Methods

retry

  • Will re-invoke the function passed to trackedFunction this will also re-set some properties on the State instance. This is the same State instance as before, as the State instance is tied to the fn passed to trackedFunction

    error or resolvedValue will remain as they were previously until this promise resolves, and then they'll be updated to the new values.

    Returns Promise<void>

Settings

Member Visibility

Theme

Generated using TypeDoc