RemoteFileSystem
Defined in: src/providers/RemoteFileSystem.ts:18
Minimal file-system surface shared by provider sessions.
Methods
Section titled “Methods”list()
Section titled “list()”list(path: string, options?: ListOptions): Promise<RemoteEntry[]>;Defined in: src/providers/RemoteFileSystem.ts:20
Lists entries for a provider path.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
path | string |
options? | ListOptions |
Returns
Section titled “Returns”Promise<RemoteEntry[]>
mkdir()?
Section titled “mkdir()?”optional mkdir(path: string, options?: MkdirOptions): Promise<void>;Defined in: src/providers/RemoteFileSystem.ts:28
Creates a directory when supported by the provider.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
path | string |
options? | MkdirOptions |
Returns
Section titled “Returns”Promise<void>
remove()?
Section titled “remove()?”optional remove(path: string, options?: RemoveOptions): Promise<void>;Defined in: src/providers/RemoteFileSystem.ts:24
Removes a file entry when supported by the provider.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
path | string |
options? | RemoveOptions |
Returns
Section titled “Returns”Promise<void>
rename()?
Section titled “rename()?”optional rename( from: string, to: string,options?: RenameOptions): Promise<void>;Defined in: src/providers/RemoteFileSystem.ts:26
Renames or moves an entry when supported by the provider.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
from | string |
to | string |
options? | RenameOptions |
Returns
Section titled “Returns”Promise<void>
rmdir()?
Section titled “rmdir()?”optional rmdir(path: string, options?: RmdirOptions): Promise<void>;Defined in: src/providers/RemoteFileSystem.ts:30
Removes a directory when supported by the provider.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
path | string |
options? | RmdirOptions |
Returns
Section titled “Returns”Promise<void>
stat()
Section titled “stat()”stat(path: string, options?: StatOptions): Promise<RemoteStat>;Defined in: src/providers/RemoteFileSystem.ts:22
Reads metadata for a provider path.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
path | string |
options? | StatOptions |
Returns
Section titled “Returns”Promise<RemoteStat>