DataObject Class
DataObject is a base data store that is primed with a root directory. It ensures that it is created and ready before you can access it.
Having a single root directory allows for easier development. Instead of creating and registering channels with the runtime any new DDS that is set on the root will automatically be registered.
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 DataObject<I extends DataObjectTypes = DataObjectTypes> extends PureDataObject<I>
Extends: PureDataObject<I>
Type Parameters
| Parameter | Constraint | Default | Description |
|---|---|---|---|
| I | DataObjectTypes | DataObjectTypes | The optional input types used to strongly type the data object |
Properties
| Property | Alerts | Modifiers | Type | Description |
|---|---|---|---|---|
| root | Alpha |
readonly |
ISharedDirectory | The root directory will either be ready or will return an error. If an error is thrown the root has not been correctly created/set. |
Property Details
root
The root directory will either be ready or will return an error. If an error is thrown the root has not been correctly created/set.
This API is provided as an alpha preview and may change without notice.
To use, import via @fluidframework/aqueduct/alpha.
For more information about our API support guarantees, see here.
Signature
protected get root(): ISharedDirectory;
Type: ISharedDirectory