IDataObjectProps Interface

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

To use, import via @fluidframework/aqueduct/legacy.

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

Signature

export interface IDataObjectProps<I extends DataObjectTypes = DataObjectTypes>

Type Parameters

Parameter	Constraint	Default	Description
I	DataObjectTypes	DataObjectTypes

Properties

Property	Alerts	Modifiers	Type	Description
context	Alpha	readonly	IFluidDataStoreContext
initProps	Alpha	optional, readonly	I["InitialState"]
providers	Alpha	readonly	AsyncFluidObjectProvider<I["OptionalProviders"]>
runtime	Alpha	readonly	IFluidDataStoreRuntime

Property Details

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

initProps

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 initProps?: I["InitialState"];

Type: I["InitialState"]

providers

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 providers: AsyncFluidObjectProvider<I["OptionalProviders"]>;

Type: AsyncFluidObjectProvider<I["OptionalProviders"]>

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