TransferState — Angular

Хранилище пар «ключ — значение», которое передаётся из приложения на стороне сервера в приложение на стороне клиента.

API

class TransferState {
  get<T>(key: StateKey<T>, defaultValue: T): T;
  set<T>(key: StateKey<T>, value: T): void;
  remove<T>(key: StateKey<T>): void;
  hasKey<T>(key: StateKey<T>): boolean;
  readonly isEmpty: boolean;
  onSerialize<T>(key: StateKey<T>, callback: () => T): void;
  toJson(): string;
}

get

T

Получает значение, соответствующее ключу. Возвращает defaultValue, если ключ не найден.

@paramkeyStateKey<T>

@paramdefaultValueT

@returnsT

set

void

Задаёт значение, соответствующее ключу.

@paramkeyStateKey<T>

@paramvalueT

@returnsvoid

remove

void

Удаляет ключ из хранилища.

@paramkeyStateKey<T>

@returnsvoid

hasKey

boolean

Проверяет, существует ли ключ в хранилище.

@paramkeyStateKey<T>

@returnsboolean

isEmpty

boolean

Указывает, является ли состояние пустым.

onSerialize

void

Регистрирует обратный вызов, который предоставляет значение для ключа при вызове toJson.

@paramkeyStateKey<T>

@paramcallback() => T

@returnsvoid

toJson

string

Сериализует текущее состояние хранилища в JSON.

@returnsstring

Описание

TransferState доступен в виде внедряемого токена. На клиенте достаточно внедрить этот токен с помощью DI и использовать его — он будет инициализирован по запросу. На сервере он уже включён, если используется функция renderApplication. В противном случае импортируйте модуль ServerTransferStateModule, чтобы сделать TransferState доступным.

Значения в хранилище сериализуются и десериализуются с помощью JSON.stringify/JSON.parse. Поэтому без потерь будут сериализованы и десериализованы только значения типов boolean, number, string, null и объекты, не являющиеся экземплярами классов.