A WritableResource created through the resource function.
API
interface ResourceRef<T> extends WritableResource<T> {
hasValue(this: T extends undefined ? this : never): this is ResourceRef<Exclude<T, undefined>>;
hasValue(): boolean;
destroy(): void;
readonly override value: WritableSignal<T>;
override set(value: T): void;
override update(updater: (value: T) => T): void;
override asReadonly(): Resource<T>;
override reload(): boolean;
readonly override status: Signal<ResourceStatus>;
readonly override error: Signal<Error | undefined>;
readonly override isLoading: Signal<boolean>;
readonly override snapshot: Signal<ResourceSnapshot<T>>;
}
hasValue
this is ResourceRef<Exclude<T, undefined>>
@paramthis
T extends undefined ? this : never
@returns
this is ResourceRef<Exclude<T, undefined>>
hasValue
boolean
@returns
boolean
destroy
voidManually destroy the resource, which cancels pending requests and returns it to idle state.
@returns
void
value
WritableSignal<T>set
voidConvenience wrapper for value.set.
@paramvalue
T
@returns
void
update
voidConvenience wrapper for value.update.
@paramupdater
(value: T) => T
@returns
void
reload
booleanInstructs the resource to re-load any asynchronous dependency it may have.
Note that the resource will not enter its reloading state until the actual backend request is made.
@returns
boolean
status
Signal<ResourceStatus>The current status of the Resource, which describes what the resource is currently doing and what can be expected of its value.
error
Signal<Error | undefined>When in the error state, this returns the last known error from the Resource.
isLoading
Signal<boolean>Whether this resource is loading a new value (or reloading the existing one).
snapshot
Signal<ResourceSnapshot<T>>The current state of this resource, represented as a ResourceSnapshot.