walkRemoteTree
function walkRemoteTree( fs: RemoteFileSystem, rootPath: string,options?: WalkRemoteTreeOptions): AsyncGenerator<RemoteTreeEntry>;Defined in: src/sync/walkRemoteTree.ts:55
Walks a remote file system depth-first, yielding entries in a stable order.
Listings are sorted by entry path within each directory so output is deterministic
across providers. Errors thrown by fs.list() propagate; callers can supply a
filter to skip directories that should not be traversed.
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
fs | RemoteFileSystem | Remote file system used for listings. |
rootPath | string | Root directory to walk. |
options | WalkRemoteTreeOptions | Optional traversal controls. |
Returns
Section titled “Returns”AsyncGenerator<RemoteTreeEntry>
Async generator emitting RemoteTreeEntry records.
Throws
Section titled “Throws”AbortError When the supplied abort signal is cancelled mid-walk.