ResourceRef — Angular

WritableResource, созданный с помощью функции resource.

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>>

@paramthisT extends undefined ? this : never

@returnsthis is ResourceRef<Exclude<T, undefined>>

hasValue

boolean

@returnsboolean

destroy

void

Вручную уничтожает ресурс, отменяя ожидающие запросы и возвращая его в состояние idle.

@returnsvoid

value

WritableSignal<T>

set

void

Упрощённая обёртка для value.set.

@paramvalueT

@returnsvoid

update

void

Упрощённая обёртка для value.update.

@paramupdater(value: T) => T

@returnsvoid

asReadonly

Resource<T>

@returnsResource<T>

reload

boolean

Указывает ресурсу повторно загрузить все имеющиеся у него асинхронные зависимости.

Обратите внимание: ресурс перейдёт в состояние перезагрузки только после отправки фактического запроса к серверу.

@returnsboolean

true, если перезагрузка была запущена; false, если перезагрузка не требовалась или не поддерживалась

status

Signal<ResourceStatus>

Текущий статус Resource, описывающий, что ресурс делает в данный момент и чего можно ожидать от его value.

error

Signal<Error | undefined>

В состоянии error здесь возвращается последняя известная ошибка Resource.

isLoading

Signal<boolean>

Показывает, загружает ли этот ресурс новое значение (или повторно загружает существующее).

snapshot

Signal<ResourceSnapshot<T>>

Текущее состояние этого ресурса, представленное в виде ResourceSnapshot.