IDirectory Interface
Packages > @fluidframework/map > IDirectory
Interface describing actions on a directory.
Signature:
export interface IDirectory extends Map<string, any>
Extends: Map<string, any>
Remarks
When used as a Map, operates on its keys.
Properties
| Property | Type | Description |
|---|---|---|
| absolutePath | string | The absolute path of the directory. |
Methods
| Method | Description |
|---|---|
| createSubDirectory(subdirName) | Creates an IDirectory child of this IDirectory. |
| deleteSubDirectory(subdirName) | Deletes an IDirectory child of this IDirectory, if it exists, along with all descendent keys and directories. |
| get(key) | Retrieves the value stored at the given key from the directory. |
| getSubDirectory(subdirName) | Gets an IDirectory child of this IDirectory, if it exists. |
| getWorkingDirectory(relativePath) | Get an IDirectory within the directory, in order to use relative paths from that location. |
| hasSubDirectory(subdirName) | Checks whether this directory has a child directory with the given name. |
| set(key, value) | Sets the value stored at key to the provided value. |
| subdirectories() | Gets an iterator over the IDirectory children of this IDirectory. |
| wait(key) | A form of get except it will only resolve the promise once the key exists in the directory. |
Events
absolutePath
The absolute path of the directory.
Signature:
readonly absolutePath: string;
Methods
createSubDirectory
Creates an IDirectory child of this IDirectory.
Signature:
createSubDirectory(subdirName: string): IDirectory;
Parameters
| Parameter | Type | Description |
|---|---|---|
| subdirName | string | Name of the new child directory to create |
Returns:
The newly created IDirectory
deleteSubDirectory
Deletes an IDirectory child of this IDirectory, if it exists, along with all descendent keys and directories.
Signature:
deleteSubDirectory(subdirName: string): boolean;
Parameters
| Parameter | Type | Description |
|---|---|---|
| subdirName | string | Name of the child directory to delete |
Returns:
boolean
True if the IDirectory existed and was deleted, false if it did not exist
get
Retrieves the value stored at the given key from the directory.
Signature:
get<T = any>(key: string): T;
Parameters
| Parameter | Type | Description |
|---|---|---|
| key | string | Key to retrieve from |
Returns:
T
The stored value, or undefined if the key is not set
getSubDirectory
Gets an IDirectory child of this IDirectory, if it exists.
Signature:
getSubDirectory(subdirName: string): IDirectory;
Parameters
| Parameter | Type | Description |
|---|---|---|
| subdirName | string | Name of the child directory to get |
Returns:
The requested IDirectory
getWorkingDirectory
Get an IDirectory within the directory, in order to use relative paths from that location.
Signature:
getWorkingDirectory(relativePath: string): IDirectory;
Parameters
| Parameter | Type | Description |
|---|---|---|
| relativePath | string | Path of the IDirectory to get, relative to this IDirectory |
Returns:
The requested IDirectory
hasSubDirectory
Checks whether this directory has a child directory with the given name.
Signature:
hasSubDirectory(subdirName: string): boolean;
Parameters
| Parameter | Type | Description |
|---|---|---|
| subdirName | string | Name of the child directory to check |
Returns:
boolean
True if it exists, false otherwise
set
Sets the value stored at key to the provided value.
Signature:
set<T = any>(key: string, value: T): this;
Parameters
| Parameter | Type | Description |
|---|---|---|
| key | string | Key to set at |
| value | T | Value to set |
Returns:
this
The IDirectory itself
subdirectories
Gets an iterator over the IDirectory children of this IDirectory.
Signature:
subdirectories(): IterableIterator<[string, IDirectory]>;
Returns:
IterableIterator<[string, IDirectory]>
The IDirectory iterator
wait
A form of get except it will only resolve the promise once the key exists in the directory.
Signature:
wait<T = any>(key: string): Promise<T>;
Parameters
| Parameter | Type | Description |
|---|---|---|
| key | string | Key to retrieve from |
Returns:
Promise<T>
The stored value once available