ISharedDirectory Interface
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.
To use, import via fluid-framework/legacy.
For more information about our API support guarantees, see here.
This type is "sealed," meaning that code outside of the library defining it should not implement or extend it. Future versions of this type may add members or make typing of readonly members more specific.
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]
For more information about our API support guarantees, see here.
This type is "sealed," meaning that code outside of the library defining it should not implement or extend it. Future versions of this type may add members or make typing of readonly members more specific.
Signature
readonly [Symbol.toStringTag]: string;
Type: string
Method Details
[Symbol.iterator]
For more information about our API support guarantees, see here.
This type is "sealed," meaning that code outside of the library defining it should not implement or extend it. Future versions of this type may add members or make typing of readonly members more specific.
Signature
[Symbol.iterator](): IterableIterator<[string, any]>;
Returns
Return type: IterableIterator<[string, any]>