encodeState

function
serialize/codec.ts:90
signature
encodeState(input, options): EncodeResult

Encodes a value into something JSON.stringify can carry losslessly.

Parameters

NameTypeDescription
inputunknownAny value, including one holding Map, Set, Date, BigInt or cycles.
NameTypeDescription
optionsEncodeOptionsRedaction and size limits.

Returns

EncodeResultThe encoded value plus a report of anything that could not be represented.

Example

example
const { value } = encodeState({ index: new Map([['a', 1]]) });
JSON.stringify(value); // safe, and decodeState restores the Map