MockFluidDataStoreContext Class
Signature
export declare class MockFluidDataStoreContext implements IFluidDataStoreContext
Implements: IFluidDataStoreContext
Constructors
| Constructor | Description |
|---|---|
| (constructor)(id, existing, logger) | Constructs a new instance of the MockFluidDataStoreContext class |
Properties
| Property | Alerts | Modifiers | Type | Description |
|---|---|---|---|---|
| attachState | AttachState | Indicates the attachment state of the data store to a host service. | ||
| baseSnapshot | ISnapshotTree | undefined | |||
| clientDetails | IClientDetails | |||
| clientId | string | undefined | |||
| connected | boolean | |||
| containerRuntime | IContainerRuntimeBase | |||
| createProps | Deprecated | optional | any | |
| deltaManager | IDeltaManager<ISequencedDocumentMessage, IDocumentMessage> | |||
| documentId | Deprecated | string | ||
| existing | boolean | |||
| id | string | |||
| IFluidDataStoreRegistry | IFluidDataStoreRegistry | |||
| IFluidHandleContext | IFluidHandleContext | |||
| isLocalDataStore | boolean | |||
| logger | ITelemetryLogger | |||
| options | ILoaderOptions | |||
| packagePath | readonly string[] | |||
| scope | FluidObject | |||
| storage | IDocumentStorageService |
Methods
| Method | Return Type | Description |
|---|---|---|
| bindToContext() | void | |
| getAbsoluteUrl(relativeUrl) | Promise<string | undefined> | |
| getAudience() | IAudience | |
| getBaseGCDetails() | Promise<IGarbageCollectionDetailsBase> | |
| getCreateChildSummarizerNodeFn(id, createParam) | CreateChildSummarizerNodeFn | |
| getInitialGCSummaryDetails() | Promise<IGarbageCollectionSummaryDetails> | |
| getQuorum() | IQuorumClients | |
| off(event, listener) | this | |
| on(event, listener) | this | |
| once(event, listener) | this | |
| setChannelDirty(address) | void | |
| submitMessage(type, content, localOpMetadata) | void | |
| submitSignal(type, content) | void | |
| uploadBlob(blob) | Promise<IFluidHandle<ArrayBufferLike>> |
Constructor Details
(constructor)
Constructs a new instance of the MockFluidDataStoreContext class
Signature
constructor(id?: string, existing?: boolean, logger?: ITelemetryLogger);
Parameters
| Parameter | Modifiers | Type | Description |
|---|---|---|---|
| id | optional | string | |
| existing | optional | boolean | |
| logger | optional | ITelemetryLogger |
Property Details
attachState
Indicates the attachment state of the data store to a host service.
Signature
attachState: AttachState;
Type: AttachState
baseSnapshot
Signature
baseSnapshot: ISnapshotTree | undefined;
Type: ISnapshotTree | undefined
clientDetails
Signature
clientDetails: IClientDetails;
Type: IClientDetails
clientId
Signature
clientId: string | undefined;
Type: string | undefined
connected
Signature
connected: boolean;
Type: boolean
containerRuntime
Signature
containerRuntime: IContainerRuntimeBase;
Type: IContainerRuntimeBase
createProps
This API is deprecated and will be removed in a future release.
0.16 Issue #1635, #3631
Signature
createProps?: any;
Type: any
deltaManager
Signature
deltaManager: IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>;
Type: IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>
documentId
This API is deprecated and will be removed in a future release.
This field is currently unused and will be removed in an upcoming breaking change
Signature
documentId: string;
Type: string
existing
Signature
readonly existing: boolean;
Type: boolean
id
Signature
readonly id: string;
Type: string
IFluidDataStoreRegistry
Signature
IFluidDataStoreRegistry: IFluidDataStoreRegistry;
Type: IFluidDataStoreRegistry
IFluidHandleContext
Signature
IFluidHandleContext: IFluidHandleContext;
Type: IFluidHandleContext
isLocalDataStore
Signature
isLocalDataStore: boolean;
Type: boolean
logger
Signature
readonly logger: ITelemetryLogger;
Type: ITelemetryLogger
options
Signature
options: ILoaderOptions;
Type: ILoaderOptions
packagePath
Signature
packagePath: readonly string[];
Type: readonly string[]
scope
Signature
scope: FluidObject;
Type: FluidObject
storage
Signature
storage: IDocumentStorageService;
Type: IDocumentStorageService
Method Details
bindToContext
Signature
bindToContext(): void;
getAbsoluteUrl
Signature
getAbsoluteUrl(relativeUrl: string): Promise<string | undefined>;
Parameters
| Parameter | Type | Description |
|---|---|---|
| relativeUrl | string |
Returns
Return type: Promise<string | undefined>
getAudience
Signature
getAudience(): IAudience;
Returns
Return type: IAudience
getBaseGCDetails
Signature
getBaseGCDetails(): Promise<IGarbageCollectionDetailsBase>;
Returns
Return type: Promise<IGarbageCollectionDetailsBase>
getCreateChildSummarizerNodeFn
Signature
getCreateChildSummarizerNodeFn(id: string, createParam: CreateChildSummarizerNodeParam): CreateChildSummarizerNodeFn;
Parameters
| Parameter | Type | Description |
|---|---|---|
| id | string | |
| createParam | CreateChildSummarizerNodeParam |
Returns
Return type: CreateChildSummarizerNodeFn
getInitialGCSummaryDetails
Signature
getInitialGCSummaryDetails(): Promise<IGarbageCollectionSummaryDetails>;
Returns
Return type: Promise<IGarbageCollectionSummaryDetails>
getQuorum
Signature
getQuorum(): IQuorumClients;
Returns
Return type: IQuorumClients
off
Signature
off(event: string | symbol, listener: (...args: any[]) => void): this;
Parameters
| Parameter | Type | Description |
|---|---|---|
| event | string | symbol | |
| listener | (...args: any[]) => void |
Returns
Return type: this
on
Signature
on(event: string | symbol, listener: (...args: any[]) => void): this;
Parameters
| Parameter | Type | Description |
|---|---|---|
| event | string | symbol | |
| listener | (...args: any[]) => void |
Returns
Return type: this
once
Signature
once(event: string | symbol, listener: (...args: any[]) => void): this;
Parameters
| Parameter | Type | Description |
|---|---|---|
| event | string | symbol | |
| listener | (...args: any[]) => void |
Returns
Return type: this
setChannelDirty
Signature
setChannelDirty(address: string): void;
Parameters
| Parameter | Type | Description |
|---|---|---|
| address | string |
submitMessage
Signature
submitMessage(type: string, content: any, localOpMetadata: unknown): void;
Parameters
| Parameter | Type | Description |
|---|---|---|
| type | string | |
| content | any | |
| localOpMetadata | unknown |
submitSignal
Signature
submitSignal(type: string, content: any): void;
Parameters
| Parameter | Type | Description |
|---|---|---|
| type | string | |
| content | any |
uploadBlob
Signature
uploadBlob(blob: ArrayBufferLike): Promise<IFluidHandle<ArrayBufferLike>>;
Parameters
| Parameter | Type | Description |
|---|---|---|
| blob | ArrayBufferLike |
Returns
Return type: Promise<IFluidHandle<ArrayBufferLike>>