Skip to main content

PureDataObjectFactory Class

PureDataObjectFactory is a bare-bones IFluidDataStoreFactory for use with PureDataObject. Consumers should typically use DataObjectFactory instead unless creating another base data store factory.

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 class PureDataObjectFactory<TObj extends PureDataObject<I>, I extends DataObjectTypes = DataObjectTypes> implements IFluidDataStoreFactory, Partial<IProvideFluidDataStoreRegistry>

Implements: IFluidDataStoreFactory, Partial<IProvideFluidDataStoreRegistry>

Type Parameters​

Parameter Constraint Default Description
TObj PureDataObject<I> DataObject (concrete type)
I DataObjectTypes DataObjectTypes The input types for the DataObject

Constructors​

Constructor Alerts Description
(constructor)(type, ctor, sharedObjects, optionalProviders, registryEntries, runtimeClass) Alpha Constructs a new instance of the PureDataObjectFactory class

Properties​

Property Alerts Modifiers Type Description
IFluidDataStoreFactory Alpha readonly this
IFluidDataStoreRegistry Alpha readonly IFluidDataStoreRegistry | undefined
registryEntry Alpha readonly NamedFluidDataStoreRegistryEntry Convenience helper to get the data store's/factory's data store registry entry. The return type hides the factory's generics, easing grouping of registry entries that differ only in this way into the same array.
type Alpha readonly string

Constructor Details​

(constructor)​

Constructs a new instance of the PureDataObjectFactory 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(
    type: string, ctor: new (props: IDataObjectProps<I>) => TObj, sharedObjects: readonly IChannelFactory[], optionalProviders: FluidObjectSymbolProvider<I["OptionalProviders"]>, registryEntries?: NamedFluidDataStoreRegistryEntries, runtimeClass?: typeof FluidDataStoreRuntime);

Parameters​

Parameter Modifiers Type Description
type string
ctor new (props: IDataObjectProps<I>) => TObj
sharedObjects readonly IChannelFactory[]
optionalProviders FluidObjectSymbolProvider<I["OptionalProviders"]>
registryEntries optional NamedFluidDataStoreRegistryEntries
runtimeClass optional typeof FluidDataStoreRuntime

Property Details​

IFluidDataStoreFactory​

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

Type: this

IFluidDataStoreRegistry​

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 IFluidDataStoreRegistry(): IFluidDataStoreRegistry | undefined;

Type: IFluidDataStoreRegistry | undefined

registryEntry​

Convenience helper to get the data store's/factory's data store registry entry. The return type hides the factory's generics, easing grouping of registry entries that differ only in this way into the same array.

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 registryEntry(): NamedFluidDataStoreRegistryEntry;

Type: NamedFluidDataStoreRegistryEntry

type​

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

Type: string