@angular/core

TransferState

Class

stable

A key value store that is transferred from the application on the server side to the application on the client side.

API

    
      class TransferState {}

get

T

Get the value corresponding to a key. Return defaultValue if key is not found.

@paramkeyStateKey<T>

@paramdefaultValueT

@returnsT

set

void

Set the value corresponding to a key.

@paramkeyStateKey<T>

@paramvalueT

@returnsvoid

remove

void

Remove a key from the store.

@paramkeyStateKey<T>

@returnsvoid

hasKey

boolean

Test whether a key exists in the store.

@paramkeyStateKey<T>

@returnsboolean

isEmpty

boolean

Indicates whether the state is empty.

onSerialize

void

@paramkeyStateKey<T>

@paramcallback() => T

@returnsvoid

toJson

string

Serialize the current state of the store to JSON.

@returnsstring

Description

A key value store that is transferred from the application on the server side to the application on the client side.

The TransferState is available as an injectable token. On the client, just inject this token using DI and use it, it will be lazily initialized. On the server it's already included if renderApplication function is used. Otherwise, import the ServerTransferStateModule module to make the TransferState available.

The values in the store are serialized/deserialized using JSON.stringify/JSON.parse. So only boolean, number, string, null and non-class objects will be serialized and deserialized in a non-lossy manner.