Skip to main content

MockFluidDataStoreContext Class

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

To use, import via @fluidframework/test-runtime-utils/legacy.

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

Signature​

export declare class MockFluidDataStoreContext implements IFluidDataStoreContext

Implements: IFluidDataStoreContext

Constructors​

Constructor Alerts Description
(constructor)(id, existing, baseLogger, interactive) Beta Constructs a new instance of the MockFluidDataStoreContext class

Properties​

Property Alerts Modifiers Type Description
attachState Beta AttachState Indicates the attachment state of the data store to a host service.
baseLogger Beta readonly ITelemetryLoggerExt
baseSnapshot Beta ISnapshotTree | undefined
clientDetails Beta IClientDetails
clientId Beta string | undefined
connected Beta boolean
containerRuntime Beta IContainerRuntimeBase
createProps Deprecated, Beta optional any
deltaManager Beta IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>
existing Beta readonly boolean
gcThrowOnTombstoneUsage Beta readonly
gcTombstoneEnforcementAllowed Beta readonly
id Beta readonly string
idCompressor Beta IIdCompressorCore & IIdCompressor
IFluidDataStoreRegistry Beta IFluidDataStoreRegistry
IFluidHandleContext Beta IFluidHandleContext
ILayerCompatDetails Beta optional unknown
isLocalDataStore Beta boolean
minVersionForCollab Beta MinimumVersionForCollab
options Beta Record<string | number, any>
packagePath Beta readonly string[]
readonly Beta boolean
scope Beta FluidObject
storage Beta IRuntimeStorageService

Methods​

Method Alerts Return Type Description
addedGCOutboundRoute(fromPath, toPath, messageTimestampMs) Beta void
deleteChildSummarizerNode(id) Beta void
getAbsoluteUrl(relativeUrl) Beta Promise<string | undefined>
getAudience() Beta IAudience
getBaseGCDetails() Beta Promise<IGarbageCollectionDetailsBase>
getCreateChildSummarizerNodeFn(id, createParam) Beta CreateChildSummarizerNodeFn
getQuorum() Beta IQuorumClients
makeLocallyVisible() Beta void
off(event, listener) Beta this
on(event, listener) Beta this
once(event, listener) Beta this
setChannelDirty(address) Beta void
submitMessage(type, content, localOpMetadata) Beta void
submitSignal(type, content) Beta void
uploadBlob(blob) Beta Promise<IFluidHandleInternal<ArrayBufferLike>>

Constructor Details​

(constructor)​

Constructs a new instance of the MockFluidDataStoreContext 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, existing?: boolean, baseLogger?: ITelemetryLoggerExt, interactive?: boolean);

Parameters​

Parameter Modifiers Type Description
id optional string
existing optional boolean
baseLogger optional ITelemetryLoggerExt
interactive optional boolean

Property Details​

attachState​

Indicates the attachment state of the data store to a host service.

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​
attachState: AttachState;

Type: AttachState

baseLogger​

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​
readonly baseLogger: ITelemetryLoggerExt;

Type: ITelemetryLoggerExt

baseSnapshot​

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​
baseSnapshot: ISnapshotTree | undefined;

Type: ISnapshotTree | undefined

clientDetails​

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​
clientDetails: IClientDetails;

Type: IClientDetails

clientId​

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​
clientId: string | undefined;

Type: string | undefined

connected​

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​
connected: boolean;

Type: boolean

containerRuntime​

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​
containerRuntime: IContainerRuntimeBase;

Type: IContainerRuntimeBase

createProps​

This API is deprecated and will be removed in a future release.

0.16 Issue #1635, #3631

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​
createProps?: any;

Type: any

deltaManager​

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​
deltaManager: IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>;

Type: IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>

existing​

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​
readonly existing: boolean;

Type: boolean

gcThrowOnTombstoneUsage​

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​
readonly gcThrowOnTombstoneUsage = false;

gcTombstoneEnforcementAllowed​

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​
readonly gcTombstoneEnforcementAllowed = false;

id​

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​
readonly id: string;

Type: string

idCompressor​

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​
idCompressor: IIdCompressorCore & IIdCompressor;

Type: IIdCompressorCore & IIdCompressor

IFluidDataStoreRegistry​

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​
IFluidDataStoreRegistry: IFluidDataStoreRegistry;

Type: IFluidDataStoreRegistry

IFluidHandleContext​

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​
IFluidHandleContext: IFluidHandleContext;

Type: IFluidHandleContext

ILayerCompatDetails​

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​
ILayerCompatDetails?: unknown;

Type: unknown

Remarks​

This is for internal use only.

isLocalDataStore​

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​
isLocalDataStore: boolean;

Type: boolean

minVersionForCollab​

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​
minVersionForCollab: MinimumVersionForCollab;

Type: MinimumVersionForCollab

options​

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​
options: Record<string | number, any>;

Type: Record<string | number, any>

packagePath​

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​
packagePath: readonly string[];

Type: readonly string[]

readonly​

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​
readonly: boolean;

Type: boolean

scope​

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​
scope: FluidObject;

Type: FluidObject

storage​

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​
storage: IRuntimeStorageService;

Type: IRuntimeStorageService

Method Details​

addedGCOutboundRoute​

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​
addedGCOutboundRoute(fromPath: string, toPath: string, messageTimestampMs?: number): void;

Parameters​

Parameter Modifiers Type Description
fromPath string
toPath string
messageTimestampMs optional number

deleteChildSummarizerNode​

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​
deleteChildSummarizerNode(id: string): void;

Parameters​

Parameter Type Description
id string

getAbsoluteUrl​

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​
getAbsoluteUrl(relativeUrl: string): Promise<string | undefined>;

Parameters​

Parameter Type Description
relativeUrl string

Returns​

Return type: Promise<string | undefined>

getAudience​

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​
getAudience(): IAudience;

Returns​

Return type: IAudience

getBaseGCDetails​

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​
getBaseGCDetails(): Promise<IGarbageCollectionDetailsBase>;

Returns​

Return type: Promise<IGarbageCollectionDetailsBase>

getCreateChildSummarizerNodeFn​

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​
getCreateChildSummarizerNodeFn(id: string, createParam: CreateChildSummarizerNodeParam): CreateChildSummarizerNodeFn;

Parameters​

Parameter Type Description
id string
createParam CreateChildSummarizerNodeParam

Returns​

Return type: CreateChildSummarizerNodeFn

getQuorum​

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​
getQuorum(): IQuorumClients;

Returns​

Return type: IQuorumClients

makeLocallyVisible​

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​
makeLocallyVisible(): void;

off​

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​
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​

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​
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​

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​
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​

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​
setChannelDirty(address: string): void;

Parameters​

Parameter Type Description
address string

submitMessage​

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​
submitMessage(type: string, content: any, localOpMetadata: unknown): void;

Parameters​

Parameter Type Description
type string
content any
localOpMetadata unknown

submitSignal​

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​
submitSignal(type: string, content: any): void;

Parameters​

Parameter Type Description
type string
content any

uploadBlob​

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​
uploadBlob(blob: ArrayBufferLike): Promise<IFluidHandleInternal<ArrayBufferLike>>;

Parameters​

Parameter Type Description
blob ArrayBufferLike

Returns​

Return type: Promise<IFluidHandleInternal<ArrayBufferLike>>