WalkRemoteTreeOptions
Defined in: src/sync/walkRemoteTree.ts:15
Options accepted by walkRemoteTree.
Properties
Section titled “Properties”| Property | Type | Description | Defined in |
|---|---|---|---|
filter? | RemoteTreeFilter | Optional filter applied before yielding and before descending into directories. | src/sync/walkRemoteTree.ts:27 |
followSymlinks? | boolean | Whether to follow symlinks during traversal. Defaults to false. | src/sync/walkRemoteTree.ts:25 |
includeDirectories? | boolean | Whether to include directory entries in the output. Defaults to true. | src/sync/walkRemoteTree.ts:21 |
includeFiles? | boolean | Whether to include file entries in the output. Defaults to true. | src/sync/walkRemoteTree.ts:23 |
maxDepth? | number | Maximum traversal depth. 0 walks only the root listing. Unbounded by default. | src/sync/walkRemoteTree.ts:19 |
recursive? | boolean | Whether to descend into subdirectories. Defaults to true. | src/sync/walkRemoteTree.ts:17 |
signal? | AbortSignal | Optional abort signal that interrupts traversal between listings. | src/sync/walkRemoteTree.ts:29 |