SharedObject Class

Helper for implementing ISharedObject with simplified, synchronous summarization and garbage collection.

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

To use, import via @fluidframework/shared-object-base/legacy.

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

Signature

export declare abstract class SharedObject<TEvent extends ISharedObjectEvents = ISharedObjectEvents> extends SharedObjectCore<TEvent>

Extends: SharedObjectCore<TEvent>

Type Parameters

Parameter	Constraint	Default	Description
TEvent	ISharedObjectEvents	ISharedObjectEvents

Remarks

DDS implementations with async and incremental summarization should extend SharedObjectCore directly instead.

Constructors

Constructor	Alerts	Description
(constructor)(id, runtime, attributes, telemetryContextPrefix)	Alpha	Constructs a new instance of the SharedObject class

Properties

Property	Alerts	Modifiers	Type	Description
serializer	Alpha	readonly	IFluidSerializer

Constructor Details

(constructor)

Constructs a new instance of the SharedObject class

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

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

Signature

constructor(id: string, runtime: IFluidDataStoreRuntime, attributes: IChannelAttributes, 
    telemetryContextPrefix: string);

Parameters

Parameter	Type	Description
id	string
runtime	IFluidDataStoreRuntime
attributes	IChannelAttributes
telemetryContextPrefix	string

Property Details

serializer

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

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

Signature

protected get serializer(): IFluidSerializer;

Type: IFluidSerializer