{ "id": "api/platform-browser/TransferState", "title": "TransferState", "contents": "\n\n
\n
\n
\n \n API > @angular/platform-browser\n
\n
\n mode_edit\n code\n
\n
\n \n
\n

TransferStatelink

\n \n \n \n \n \n
\n \n \n\n
\n \n
\n

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

\n\n

See more...

\n
\n \n \n \n
\n\nclass TransferState {\n get<T>(key: StateKey<T>, defaultValue: T): T\n set<T>(key: StateKey<T>, value: T): void\n remove<T>(key: StateKey<T>): void\n hasKey<T>(key: StateKey<T>)\n onSerialize<T>(key: StateKey<T>, callback: () => T): void\n toJson(): string\n}\n\n\n \n \n\n
\n\n\n \n\n \n \n
\n

Descriptionlink

\n

TransferState will be available as an injectable token. To use it import\nServerTransferStateModule on the server and BrowserTransferStateModule on the client.

\n

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

\n\n \n
\n\n \n\n\n\n\n\n\n\n\n\n\n\n\n
\n

Methodslink

\n \n \n\n \n \n \n \n \n \n \n \n \n \n\n \n\n \n \n
\n
\n

\n get()\n \n link

\n
\n mode_edit\n code\n
\n
\n
\n

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

\n\n
\n
\n \n\n get<T>(key: StateKey<T>, defaultValue: T): T\n\n \n\n
Parameters
\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
\n \n key\n StateKey\n \n \n
\n \n defaultValue\n T\n \n \n
\n\n \n
Returns
\n

T

\n\n \n\n\n \n\n \n
\n
\n\n \n \n\n \n \n \n \n \n \n \n \n \n \n\n \n\n \n \n
\n
\n

\n set()\n \n link

\n
\n mode_edit\n code\n
\n
\n
\n

Set the value corresponding to a key.

\n\n
\n
\n \n\n set<T>(key: StateKey<T>, value: T): void\n\n \n\n
Parameters
\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
\n \n key\n StateKey\n \n \n
\n \n value\n T\n \n \n
\n\n \n
Returns
\n

void

\n\n \n\n\n \n\n \n
\n
\n\n \n \n\n \n \n \n \n \n \n \n \n \n \n\n \n\n \n \n
\n
\n

\n remove()\n \n link

\n
\n mode_edit\n code\n
\n
\n
\n

Remove a key from the store.

\n\n
\n
\n \n\n remove<T>(key: StateKey<T>): void\n\n \n\n
Parameters
\n \n \n \n \n \n \n \n \n \n
\n \n key\n StateKey\n \n \n
\n\n \n
Returns
\n

void

\n\n \n\n\n \n\n \n
\n
\n\n \n \n\n \n \n \n \n \n \n \n \n \n \n\n \n\n \n \n
\n
\n

\n hasKey()\n \n link

\n
\n mode_edit\n code\n
\n
\n
\n

Test whether a key exists in the store.

\n\n
\n
\n \n\n hasKey<T>(key: StateKey<T>)\n\n \n\n
Parameters
\n \n \n \n \n \n \n \n \n \n
\n \n key\n StateKey\n \n \n
\n\n \n\n\n \n\n \n
\n
\n\n \n \n\n \n \n \n \n \n \n \n \n \n \n\n \n\n \n \n
\n
\n

\n onSerialize()\n \n link

\n
\n mode_edit\n code\n
\n
\n
\n

Register a callback to provide the value for a key when toJson is called.

\n\n
\n
\n \n\n onSerialize<T>(key: StateKey<T>, callback: () => T): void\n\n \n\n
Parameters
\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
\n \n key\n StateKey\n \n \n
\n \n callback\n () => T\n \n \n
\n\n \n
Returns
\n

void

\n\n \n\n\n \n\n \n
\n
\n\n \n \n\n \n \n \n \n \n \n \n \n \n \n\n \n\n \n \n
\n
\n

\n toJson()\n \n link

\n
\n mode_edit\n code\n
\n
\n
\n

Serialize the current state of the store to JSON.

\n\n
\n
\n \n\n toJson(): string\n\n \n\n
Parameters
\n

There are no parameters.

\n\n \n
Returns
\n

string

\n\n \n\n\n \n\n \n
\n
\n\n \n
\n\n\n\n \n\n\n
\n
\n\n\n" }