IDirectoryDataObject Interface
Packages > @fluidframework/map > IDirectoryDataObject
Defines the in-memory object structure to be used for the conversion to/from serialized.
This API is deprecated and will be removed in a future release.
- This interface will no longer be exported in the future(AB#8004).
This API is provided for existing users, but is not recommended for new users.
To use, import via @fluidframework/map/legacy.
For more information about our API support guarantees, see here .
Signature
export interface IDirectoryDataObject
Remarks
Directly used in JSON.stringify , direct result from JSON.parse .
Properties
| Property | Alerts | Modifiers | Type | Description |
|---|---|---|---|---|
| ci |
Alpha
|
optional
|
ICreateInfo | Create info for the sub directory. Since directories with same name can get deleted/created by multiple clients asynchronously, this info helps us to determine whether the ops where for the current instance of sub directory or not and whether to process them or not based on that. Summaries which were not produced which this change will not have this info and in that case we can still run in eventual consistency issues but that is no worse than the state before this change. |
| storage |
Alpha
|
optional
|
Record<string, ISerializableValue> | Key/value date set by the user. |
| subdirectories |
Alpha
|
optional
|
Record<string, IDirectoryDataObject> | Recursive sub-directories objects. |
Property Details
ci
Create info for the sub directory. Since directories with same name can get deleted/created by multiple clients asynchronously, this info helps us to determine whether the ops where for the current instance of sub directory or not and whether to process them or not based on that. Summaries which were not produced which this change will not have this info and in that case we can still run in eventual consistency issues but that is no worse than the state before this change.
This API is provided as an alpha preview and may change without notice.
To use, import via @fluidframework/map/alpha.
For more information about our API support guarantees, see here .
Signature
ci?: ICreateInfo;
Type: ICreateInfo
storage
Key/value date set by the user.
This API is provided as an alpha preview and may change without notice.
To use, import via @fluidframework/map/alpha.
For more information about our API support guarantees, see here .
Signature
storage?: Record<string, ISerializableValue>;
Type: Record<string, ISerializableValue >
subdirectories
Recursive sub-directories objects .
This API is provided as an alpha preview and may change without notice.
To use, import via @fluidframework/map/alpha.
For more information about our API support guarantees, see here .
Signature
subdirectories?: Record<string, IDirectoryDataObject>;
Type: Record<string, IDirectoryDataObject >