Skip to main content

MockHandle Class

Mock implementation of IFluidHandle.

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 MockHandle<T> extends FluidHandleBase<T>

Extends: FluidHandleBase<T>

Type Parameters​

Parameter Description
T

Constructors​

Constructor Alerts Description
(constructor)(value, path, absolutePath) Alpha Constructs a new instance of the MockHandle class

Properties​

Property Alerts Modifiers Type Description
absolutePath Alpha readonly string
isAttached Alpha readonly boolean
path Alpha readonly string
value Alpha readonly T

Constructor Details​

(constructor)​

Constructs a new instance of the MockHandle 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(value: T, path?: string, absolutePath?: string);

Parameters​

Parameter Modifiers Type Description
value T
path optional string
absolutePath optional string

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​

readonly absolutePath: string;

Type: string

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

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

Type: string

value​

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​

protected readonly value: T;

Type: T