Skip to main content

PureDataObject Class

This is a bare-bones base class that does basic setup and enables for factory on an initialize call.

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 declare abstract class PureDataObject<I extends DataObjectTypes = DataObjectTypes> extends TypedEventEmitter<I["Events"] & IEvent> implements IFluidLoadable, IProvideFluidHandle

Extends: TypedEventEmitter<I["Events"] & IEvent>

Implements: IFluidLoadable, IProvideFluidHandle

Type Parameters​

Parameter Constraint Default Description
I DataObjectTypes DataObjectTypes The optional input types used to strongly type the data object

Remarks​

You probably don't want to inherit from this data store directly unless you are creating another base data store class.

Constructors​

Constructor Alerts Description
(constructor)(props) Alpha Constructs a new instance of the PureDataObject class

Properties​

Property Alerts Modifiers Type Description
context Alpha readonly IFluidDataStoreContext This context is used to talk up to the IContainerRuntime
handle Alpha readonly IFluidHandleInternal<this> Handle to a data store
id Alpha readonly string
IFluidHandle Alpha readonly IFluidHandleInternal<this>
IFluidLoadable Alpha readonly this
initializeP Alpha Promise<void> | undefined Internal implementation detail. Subclasses should not use this.
initProps Alpha optional I["InitialState"]
providers Alpha readonly AsyncFluidObjectProvider<I["OptionalProviders"]>

Providers are FluidObject keyed objects that provide back a promise to the corresponding FluidObject or undefined. Providers injected/provided by the Container and/or HostingApplication

To define providers set FluidObject interfaces in the OptionalProviders generic type for your data store
runtime Alpha readonly IFluidDataStoreRuntime This is your FluidDataStoreRuntime object

Constructor Details​

(constructor)​

Constructs a new instance of the PureDataObject 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(props: IDataObjectProps<I>);

Parameters​

Parameter Type Description
props IDataObjectProps<I>

Property Details​

context​

This context is used to talk up to the IContainerRuntime

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

Type: IFluidDataStoreContext

handle​

Handle to a data store

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 handle(): IFluidHandleInternal<this>;

Type: IFluidHandleInternal<this>

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​

get id(): string;

Type: string

IFluidHandle​

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 IFluidHandle(): IFluidHandleInternal<this>;

Type: IFluidHandleInternal<this>

IFluidLoadable​

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 IFluidLoadable(): this;

Type: this

initializeP​

Internal implementation detail. Subclasses should not use this.

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 initializeP: Promise<void> | undefined;

Type: Promise<void> | undefined

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​

protected initProps?: I["InitialState"];

Type: I["InitialState"]

providers​

Providers are FluidObject keyed objects that provide back a promise to the corresponding FluidObject or undefined. Providers injected/provided by the Container and/or HostingApplication

To define providers set FluidObject interfaces in the OptionalProviders generic type for your data store

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

Type: AsyncFluidObjectProvider<I["OptionalProviders"]>

runtime​

This is your FluidDataStoreRuntime object

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

Type: IFluidDataStoreRuntime