Packages > @fluidframework/shared-object-base > ISharedObject
ISharedObject Interface
Base interface for shared objects from which other interfaces derive. Implemented by SharedObject
Signature
export interface ISharedObject<TEvent extends ISharedObjectEvents = ISharedObjectEvents> extends IChannel, IEventProvider<TEvent>
Extends: IChannel , IEventProvider <TEvent>
Type Parameters
| Parameter | Constraint | Default | Description |
|---|---|---|---|
| TEvent | ISharedObjectEvents | ISharedObjectEvents |
Methods
| Method | Return Type | Description |
|---|---|---|
| bindToContext() | void | Binds the given shared object to its containing data store runtime, causing it to attach once the runtime attaches. |
| getGCData(fullGC) | IGarbageCollectionData | Returns the GC data for this shared object. It contains a list of GC nodes that contains references to other GC nodes. |
Method Details
bindToContext
Binds the given shared object to its containing data store runtime, causing it to attach once the runtime attaches.
Signature
bindToContext(): void;
getGCData
Returns the GC data for this shared object. It contains a list of GC nodes that contains references to other GC nodes.
Signature
getGCData(fullGC?: boolean): IGarbageCollectionData;
Parameters
| Parameter | Modifiers | Type | Description |
|---|---|---|---|
| fullGC | optional | boolean | true to bypass optimizations and force full generation of GC data. |
Returns
Return type: IGarbageCollectionData