Skip to main content

ISnapshotable Interface

Interface for object that can be snapshoted

TODO: move this to be use in other place TODO: currently input and output is not symmetrical, can they become symmetrical?

This API is provided for existing users, but is not recommended for new users.

To use, import via @fluidframework/ordered-collection/legacy.

For more information about our API support guarantees, see here.

Signature

export interface ISnapshotable<T>

Type Parameters

Parameter Description
T

Methods

Method Alerts Return Type Description
asArray() Alpha T[]
loadFrom(values) Alpha void

Method Details

asArray

This API is provided as an alpha preview and may change without notice.

To use, import via @fluidframework/ordered-collection/alpha.

For more information about our API support guarantees, see here.

Signature

asArray(): T[];

Returns

Return type: T[]

loadFrom

This API is provided as an alpha preview and may change without notice.

To use, import via @fluidframework/ordered-collection/alpha.

For more information about our API support guarantees, see here.

Signature

loadFrom(values: T[]): void;

Parameters

Parameter Type Description
values T[]