Skip to main content

Function: fromSnapshot()

Call Signature​

function fromSnapshot<TType>(
type,
snapshot,
options?
): TypeToData<TType>;

Given a type deserializes a data structure from its snapshot form.

Type Parameters​

Type ParameterDescription
TType extends AnyTypeObject type.

Parameters​

ParameterTypeDescription
typeTTypeType.
snapshotTypeToSnapshotIn<TType>Snapshot, even if a primitive.
options?Partial<FromSnapshotOptions>Options.

Returns​

TypeToData<TType>

The deserialized object.

Call Signature​

function fromSnapshot<T>(snapshot, options?): T;

Deserializes a data structure from its snapshot form.

Type Parameters​

Type ParameterDescription
TObject type.

Parameters​

ParameterTypeDescription
snapshot| SnapshotInOf<T> | SnapshotOutOf<T>Snapshot, even if a primitive.
options?Partial<FromSnapshotOptions>Options.

Returns​

T

The deserialized object.