DataObjectTypes Interface
This type is used as the base generic input to DataObject and PureDataObject.
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 DataObjectTypes
Properties
| Property | Alerts | Modifiers | Type | Description |
|---|---|---|---|---|
| Events | Alpha |
optional |
IEvent | Represents events that will be available in the EventForwarder. |
| InitialState | Alpha |
optional |
any | The initial state type that the produced data object may take during creation. |
| OptionalProviders | Alpha |
optional |
FluidObject | Represents a type that will define optional providers that will be injected. |
Property Details
Events
Represents events that will be available in the EventForwarder.
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
Events?: IEvent;
Type: IEvent
InitialState
The initial state type that the produced data object may take during creation.
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
InitialState?: any;
Type: any
OptionalProviders
Represents a type that will define optional providers that will be injected.
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
OptionalProviders?: FluidObject;
Type: FluidObject