TransferState
class
A key value store that is transferred from the application on the server side to the application on the client side.
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>) onSerialize<T>(key: StateKey<T>, callback: () => T): void toJson(): string }
Description
TransferState
will be available as an injectable token. To use it import ServerTransferStateModule
on the server and BrowserTransferStateModule
on the client.
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 deserialzied in a non-lossy manner.
Methods
get()
|
||||
---|---|---|---|---|
Get the value corresponding to a key. Return |
||||
|
key | Type: |
defaultValue | Type: |
Returns
T
set()
|
||||
---|---|---|---|---|
Set the value corresponding to a key. |
||||
|
key | Type: |
value | Type: |
Returns
void
remove()
|
||
---|---|---|
Remove a key from the store. |
||
|
key | Type: |
Returns
void
hasKey()
|
||
---|---|---|
Test whether a key exists in the store. |
||
|
key | Type: |
onSerialize()
|
||||
---|---|---|---|---|
Register a callback to provide the value for a key when |
||||
|
key | Type: |
callback | Type: |
Returns
void
toJson()
|
---|
Serialize the current state of the store to JSON. |
|
© 2010–2019 Google, Inc.
Licensed under the Creative Commons Attribution License 4.0.
https://v6.angular.io/api/platform-browser/TransferState