Skip to main content
Version: v1

LocalValueMaker Class

A LocalValueMaker enables a container type DDS to produce and store local values with minimal awareness of how those objects are stored, serialized, and deserialized.

Signature

export declare class LocalValueMaker

Constructors

ConstructorDescription
(constructor)(serializer)Create a new LocalValueMaker.

Methods

MethodReturn TypeDescription
fromInMemory(value)ILocalValueCreate a new local value containing a given plain object.
fromSerializable(serializable)ILocalValueCreate a new local value from an incoming serialized value.

Constructor Details

(constructor)

Create a new LocalValueMaker.

Signature

constructor(serializer: IFluidSerializer);

Parameters

ParameterTypeDescription
serializerIFluidSerializerThe serializer to serialize / parse handles.

Method Details

fromInMemory

Create a new local value containing a given plain object.

Signature

fromInMemory(value: any): ILocalValue;

Parameters

ParameterTypeDescription
valueanyThe value to store

Returns

An ILocalValue containing the value

Return type: ILocalValue

fromSerializable

Create a new local value from an incoming serialized value.

Signature

fromSerializable(serializable: ISerializableValue): ILocalValue;

Parameters

ParameterTypeDescription
serializableISerializableValueThe serializable value to make local

Returns

Return type: ILocalValue