@fluidframework/map Package
The map library provides interfaces and implementing classes for map-like distributed data structures.
Remarks
The following distributed data structures are defined in this library:
-
SharedMap
-
SharedDirectory
Interfaces
| Interface | Alerts | Modifiers | Description |
|---|---|---|---|
| ICreateInfo | Deprecated, Legacy, Alpha |
Create info for the subdirectory. | |
| IDirectory | Legacy |
sealed |
Interface describing actions on a directory. |
| IDirectoryDataObject | Deprecated, Legacy, Alpha |
Defines the in-memory object structure to be used for the conversion to/from serialized. | |
| IDirectoryEvents | Legacy |
sealed |
Events emitted in response to changes to the directory data. |
| IDirectoryNewStorageFormat | Deprecated, Legacy, Alpha |
IDirectory storage format. | |
| IDirectoryValueChanged | Legacy |
sealed |
Type of "valueChanged" event parameter for ISharedDirectory. |
| ISerializableValue | Deprecated, Legacy, Alpha |
The _ready-for-serialization_ format of values contained in DDS contents. This allows us to use type to understand whether they're storing a Plain JavaScript object, a SharedObject, or a value type. | |
| ISharedDirectory | Legacy, Alpha |
sealed |
Provides a hierarchical organization of map-like data structures as SubDirectories. The values stored within can be accessed like a map, and the hierarchy can be navigated using path syntax. SubDirectories can be retrieved for use as working directories. |
| ISharedDirectoryEvents | Legacy, Alpha |
sealed |
Events emitted in response to changes to the directory data. |
| ISharedMap | Legacy, Alpha |
sealed |
The SharedMap distributed data structure can be used to store key-value pairs. |
| ISharedMapEvents | Legacy, Alpha |
sealed |
Events emitted in response to changes to the map data. |
| IValueChanged | Legacy |
sealed |
Type of "valueChanged" event parameter. |
Classes
| Class | Alerts | Modifiers | Description |
|---|---|---|---|
| DirectoryFactory | Legacy, Alpha |
sealed |
IChannelFactory for ISharedDirectory. |
| MapFactory | Legacy, Alpha |
sealed |
IChannelFactory for ISharedMap. |
Types
| TypeAlias | Alerts | Description |
|---|---|---|
| SharedDirectory | Legacy, Alpha |
Entrypoint for ISharedDirectory creation. |
| SharedMap | Legacy, Alpha |
Entrypoint for ISharedMap creation. |
Variables
| Variable | Alerts | Modifiers | Type | Description |
|---|---|---|---|---|
| SharedDirectory | Legacy, Alpha |
readonly |
import("@fluidframework/shared-object-base/internal").ISharedObjectKind<ISharedDirectory> & import("@fluidframework/shared-object-base/internal").SharedObjectKind<ISharedDirectory> | Entrypoint for ISharedDirectory creation. |
| SharedMap | Legacy, Alpha |
readonly |
import("@fluidframework/shared-object-base/internal").ISharedObjectKind<ISharedMap> & import("@fluidframework/shared-object-base/internal").SharedObjectKind<ISharedMap> | Entrypoint for ISharedMap creation. |
Variable Details
SharedDirectory
Entrypoint for ISharedDirectory creation.
To use, import via @fluidframework/map/legacy.
For more information about our API support guarantees, see here.
Signature
SharedDirectory: import("@fluidframework/shared-object-base/internal").ISharedObjectKind<ISharedDirectory> & import("@fluidframework/shared-object-base/internal").SharedObjectKind<ISharedDirectory>
Type: import("@fluidframework/shared-object-base/internal").ISharedObjectKind<ISharedDirectory> & import("@fluidframework/shared-object-base/internal").SharedObjectKind<ISharedDirectory>
SharedMap
Entrypoint for ISharedMap creation.
To use, import via @fluidframework/map/legacy.
For more information about our API support guarantees, see here.
Signature
SharedMap: import("@fluidframework/shared-object-base/internal").ISharedObjectKind<ISharedMap> & import("@fluidframework/shared-object-base/internal").SharedObjectKind<ISharedMap>
Type: import("@fluidframework/shared-object-base/internal").ISharedObjectKind<ISharedMap> & import("@fluidframework/shared-object-base/internal").SharedObjectKind<ISharedMap>