PromiseResourceOptions — Angular

Параметры функции resource для создания ресурса.

API

interface PromiseResourceOptions<T, R> extends BaseResourceOptions<T, R> {
  loader: ResourceLoader<T, R>;
  stream?: undefined;
  override params?: ((ctx: ResourceParamsContext) => R) | undefined;
  override defaultValue?: NoInfer<T> | undefined;
  override equal?: ValueEqualityFn<T> | undefined;
  override injector?: Injector | undefined;
  override id?: string | undefined;
}

loader

ResourceLoader<T, R>

Функция загрузки, возвращающая Promise значения ресурса для заданного запроса.

stream

undefined

Нельзя указывать stream и loader одновременно.

params

((ctx: ResourceParamsContext) => R) | undefined

Реактивная функция, определяющая отправляемый запрос. При каждом изменении запроса будет вызываться загрузчик, чтобы получить новое значение ресурса.

Если функция params не указана, загрузчик не будет запускаться повторно, пока ресурс не будет перезагружен.

defaultValue

NoInfer<T> | undefined

Значение, возвращаемое ресурсом, когда значение сервера недоступно, например пока ресурс загружается.

equal

ValueEqualityFn<T> | undefined

Функция сравнения, используемая для проверки равенства возвращаемых загрузчиком значений.

injector

Injector | undefined

Переопределяет Injector, используемый функцией resource.

id

string | undefined

Идентификатор, используемый для кэширования данных ресурса в TransferState во время серверного рендеринга и для их получения на стороне клиента. Это значение должно быть одинаковым как на клиенте, так и на сервере.