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) Alpha Constructs a new instance of the MockFluidDataStoreContext class

Properties​

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

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

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: IDocumentStorageService;

Type: IDocumentStorageService