ITestFluidObject Interface

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

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

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

Signature

export interface ITestFluidObject extends IProvideTestFluidObject, IFluidLoadable

Extends: IProvideTestFluidObject, IFluidLoadable

Properties

Property	Alerts	Modifiers	Type	Description
channel	Alpha	readonly	IFluidDataStoreChannel
context	Alpha	readonly	IFluidDataStoreContext
root	Alpha		ISharedMap
runtime	Alpha	readonly	IFluidDataStoreRuntime

Methods

Method	Alerts	Return Type	Description
getSharedObject(id)	Alpha	Promise<T>

Property Details

channel

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 channel: IFluidDataStoreChannel;

Type: IFluidDataStoreChannel

context

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 context: IFluidDataStoreContext;

Type: IFluidDataStoreContext

root

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

root: ISharedMap;

Type: ISharedMap

runtime

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 runtime: IFluidDataStoreRuntime;

Type: IFluidDataStoreRuntime

Method Details

getSharedObject

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

getSharedObject<T = any>(id: string): Promise<T>;

Type Parameters

Parameter	Default	Description
T	any

Parameters

Parameter	Type	Description
id	string

Returns

Return type: Promise<T>