more_horiz
@angular/corecode
WritableResource
interface
stablesince v22.0
A Resource with a mutable value.
On this page
API
interface WritableResource<T> extends Resource<T> { readonly value: WritableSignal<T>; hasValue(this: T extends undefined ? this : never): this is WritableResource<Exclude<T, undefined>>; hasValue(): boolean; set(value: T): void; update(updater: (value: T) => T): void; asReadonly(): Resource<T>; 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
2 overloads@paramthis
T extends undefined ? this : never@returns
this is WritableResource<Exclude<T, undefined>>@returns
booleanreload
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
booleantrue if a reload was initiated, false if a reload was unnecessary or unsupported
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.
Description
A Resource with a mutable value.
Overwriting the value of a resource sets it to the 'local' state.
Jump to details