ISharedDirectory Interface
Packages > fluid-framework > ISharedDirectory
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.
This API is provided for existing users, but is not recommended for new users.
To use, import via fluid-framework/legacy.
For more information about our API support guarantees, see here .
Signature
/** @sealed */
export interface ISharedDirectory extends ISharedObject<ISharedDirectoryEvents & IDirectoryEvents>, Omit<IDirectory, "on" | "once" | "off">
Extends: ISharedObject <ISharedDirectoryEvents & IDirectoryEvents >, Omit<IDirectory , “on” | “once” | “off”>
Properties
| Property | Alerts | Modifiers | Type | Description |
|---|---|---|---|---|
| [Symbol.toStringTag] |
Alpha
|
readonly
|
string |
Methods
| Method | Alerts | Return Type | Description |
|---|---|---|---|
| [Symbol.iterator]() |
Alpha
|
IterableIterator<[string, any]> |
Property Details
[Symbol.toStringTag]
This API is provided as an alpha preview and may change without notice.
To use, import via fluid-framework/alpha.
For more information about our API support guarantees, see here .
Signature
readonly [Symbol.toStringTag]: string;
Type: string
Method Details
[Symbol.iterator]
This API is provided as an alpha preview and may change without notice.
To use, import via fluid-framework/alpha.
For more information about our API support guarantees, see here .
Signature
[Symbol.iterator](): IterableIterator<[string, any]>;
Returns
Return type: IterableIterator<[string, any]>