StreamingResourceOptions — Angular

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

API

interface StreamingResourceOptions<T, R> extends BaseResourceOptions<T, R> {
  stream: ResourceStreamingLoader<T, R>;
  loader?: 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;
}

stream

ResourceStreamingLoader<T, R>

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

loader

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 при серверном рендеринге и их получения на стороне клиента. Это значение должно быть одинаковым на клиенте и сервере.