This is the dev preview website. Check out the document at lynxjs.org

Home > @lynx-js/genui > RawResource

RawResource interface

Signature:

export interface Resource<T = unknown> 

Properties

Property

Modifiers

Type

Description

complete

(result: T) => void

completed

readonly

boolean

error

readonly

unknown

fail

(err: unknown) => void

getSnapshot

() => ResourceSnapshot<T>

Synchronous read of the current snapshot, suitable for useSyncExternalStore. The returned object reference changes on every transition.

id

string

onUpdate

(callback: (result: T) => void) => () => void

promise

Promise<T>

read

() => T | undefined

status

readonly

ResourceStatus

subscribe

(callback: () => void) => () => void

Subscribe to state changes. The callback is invoked after every complete() or fail() (the same value may be re-published when the processor re-emits an update for the same id). Returns a disposer.

value

readonly

T | undefined