Skip to main content

MockFluidDataStoreRuntime Class

Mock implementation of IRuntime for testing that does nothing

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 MockFluidDataStoreRuntime extends EventEmitter implements IFluidDataStoreRuntime, IFluidDataStoreChannel, IFluidHandleContext

Extends: EventEmitter

Implements: IFluidDataStoreRuntime, IFluidDataStoreChannel, IFluidHandleContext

Constructors​

Constructor Alerts Description
(constructor)(overrides) Alpha Constructs a new instance of the MockFluidDataStoreRuntime class

Properties​

Property Alerts Modifiers Type Description
absolutePath Alpha readonly string
attachState Alpha readonly AttachState
channelsRoutingContext Alpha readonly IFluidHandleContext
clientId Alpha string
connected Alpha readonly
containerRuntime Alpha optional MockContainerRuntime
deltaManager Alpha readonly IDeltaManagerErased
deltaManagerInternal Alpha MockDeltaManager
disposed Alpha readonly boolean
documentId Alpha readonly string
entryPoint Alpha readonly IFluidHandleInternal<FluidObject>
existing Alpha readonly boolean
id Alpha readonly string
idCompressor Alpha (IIdCompressor & IIdCompressorCore) | undefined
IFluidHandleContext Alpha readonly IFluidHandleContext
ILayerCompatDetails Alpha optional unknown
isAttached Alpha readonly boolean
isReadOnly Alpha readonly () => boolean
loader Alpha readonly ILoader
local Deprecated, Alpha boolean
logger Alpha readonly ITelemetryBaseLogger
objectsRoutingContext Alpha readonly IFluidHandleContext
options Alpha Record<string | number, any>
path Alpha readonly
quorum Alpha MockQuorumClients
rootRoutingContext Alpha readonly IFluidHandleContext
visibilityState Alpha readonly VisibilityState

Constructor Details​

(constructor)​

Constructs a new instance of the MockFluidDataStoreRuntime 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(overrides?: {
        clientId?: string;
        entryPoint?: IFluidHandle<FluidObject>;
        id?: string;
        logger?: ITelemetryBaseLogger;
        idCompressor?: IIdCompressor & IIdCompressorCore;
        attachState?: AttachState;
        registry?: readonly IChannelFactory[];
    });

Parameters​

Parameter Modifiers Type Description
overrides optional { clientId?: string; entryPoint?: IFluidHandle<FluidObject>; id?: string; logger?: ITelemetryBaseLogger; idCompressor?: IIdCompressor & IIdCompressorCore; attachState?: AttachState; registry?: readonly IChannelFactory[]; }

Property Details​

absolutePath​

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​
get absolutePath(): string;

Type: string

attachState​

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

Type: AttachState

channelsRoutingContext​

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​
get channelsRoutingContext(): IFluidHandleContext;

Type: IFluidHandleContext

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;

Type: string

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​
readonly connected = true;

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?: MockContainerRuntime;

Type: MockContainerRuntime

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​
get deltaManager(): IDeltaManagerErased;

Type: IDeltaManagerErased

deltaManagerInternal​

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​
deltaManagerInternal: MockDeltaManager;

Type: MockDeltaManager

disposed​

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​
get disposed(): boolean;

Type: boolean

documentId​

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 documentId: string;

Type: string

entryPoint​

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 entryPoint: IFluidHandleInternal<FluidObject>;

Type: IFluidHandleInternal<FluidObject>

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

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: (IIdCompressor & IIdCompressorCore) | undefined;

Type: (IIdCompressor & IIdCompressorCore) | undefined

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

isAttached​

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​
get isAttached(): boolean;

Type: boolean

isReadOnly​

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 isReadOnly: () => boolean;

Type: () => boolean

loader​

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 loader: ILoader;

Type: ILoader

local​

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

Use attachState instead

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​
get local(): boolean;
set local(local: boolean);

Type: boolean

logger​

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 logger: ITelemetryBaseLogger;

Type: ITelemetryBaseLogger

objectsRoutingContext​

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​
get objectsRoutingContext(): IFluidHandleContext;

Type: IFluidHandleContext

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>

path​

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 path = "";

quorum​

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​
quorum: MockQuorumClients;

Type: MockQuorumClients

rootRoutingContext​

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​
get rootRoutingContext(): IFluidHandleContext;

Type: IFluidHandleContext

visibilityState​

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​
get visibilityState(): VisibilityState;

Type: VisibilityState