ToSignalOptions — Angular

Параметры для toSignal.

API

interface ToSignalOptions<T> {
  initialValue?: unknown;
  requireSync?: boolean | undefined;
  injector?: Injector | undefined;
  manualCleanup?: boolean | undefined;
  equal?: ValueEqualityFn<T> | undefined;
  debugName?: string | undefined;
}

initialValue

unknown

Начальное значение сигнала, создаваемого с помощью toSignal.

Это будет значение сигнала до тех пор, пока observable не выдаст первое значение.

requireSync

boolean | undefined

Требовать ли, чтобы observable выдавал значение синхронно при подписке toSignal.

Если это значение равно true, toSignal проверит, что observable немедленно выдаёт значение при подписке. Установка этого параметра избавляет от необходимости обрабатывать undefined в типе сигнала или указывать initialValue, но при невыполнении этого требования возникнет ошибка во время выполнения.

injector

Injector | undefined

Injector, который предоставит DestroyRef, используемый для очистки подписки на Observable.

Если он не указан, DestroyRef будет получен из текущего контекста внедрения зависимостей, если только не запрошена ручная очистка.

manualCleanup

boolean | undefined

Следует ли автоматически очищать подписку (с помощью DestroyRef) при уничтожении контекста создания toSignal.

Если включена ручная очистка, DestroyRef не используется, а подписка сохраняется до завершения самого Observable.

equal

ValueEqualityFn<T> | undefined

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

Сравнение на равенство выполняется также для начального значения, если оно указано.

debugName

string | undefined

Отладочное имя сигнала. Используется в Angular DevTools для идентификации сигнала.