Skip to main content

DataObjectFactory Class

DataObjectFactory is the IFluidDataStoreFactory for use with DataObjects. It facilitates DataObject's features (such as its shared directory) by ensuring relevant shared objects etc are available to the 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 DataObjectFactory<TObj extends DataObject<I>, I extends DataObjectTypes = DataObjectTypes> extends PureDataObjectFactory<TObj, I>

Extends: PureDataObjectFactory<TObj, I>

Type Parameters

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

Constructors

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

Constructor Details

(constructor)

Constructs a new instance of the DataObjectFactory 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<unknown>[] | undefined, optionalProviders: FluidObjectSymbolProvider<I["OptionalProviders"]>, registryEntries?: NamedFluidDataStoreRegistryEntries, runtimeFactory?: typeof FluidDataStoreRuntime);

Parameters

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