TransferState

class

npm Package	@angular/platform-browser
Module	import { TransferState } from '@angular/platform-browser';
Source	platform-browser/src/browser/transfer_state.ts

Overview

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

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

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.

Static Members

Members

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

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

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

Set the value corresponding to a key.

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

Remove a key from the store.

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

Test whether a key exists in the store.

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

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

toJson(): string

Serialize the current state of the store to JSON.

Annotations

@Injectable()