模板语法
服务端渲染
API / @angular/platform-browser

TransferState

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 }

说明

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.

方法

get()

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

get<T>(key: StateKey<T>, defaultValue: T): T

参数

key

Type: StateKey.

defaultValue

Type: T.

返回值

T

set()

Set the value corresponding to a key.

set<T>(key: StateKey<T>, value: T): void

参数

key

Type: StateKey.

value

Type: T.

返回值

void

remove()

Remove a key from the store.

remove<T>(key: StateKey<T>): void

参数

key

Type: StateKey.

返回值

void

hasKey()

Test whether a key exists in the store.

hasKey<T>(key: StateKey<T>)

参数

key

Type: StateKey.

onSerialize()

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

onSerialize<T>(key: StateKey<T>, callback: () => T): void

参数

key

Type: StateKey.

callback

Type: () => T.

返回值

void

toJson()

Serialize the current state of the store to JSON.

toJson(): string

参数

没有参数。

返回值

string

注解

@Injectable()