Creates a new LocalFolder for the given root directory.
Absolute or relative path to the local directory to scan.
ReadonlyappliesTrue when scan(filters) already enforces include/exclude filters itself as an optimization.
The synchronizer still reapplies filters after custom scanner output as the SDK policy
boundary. Custom folders that set this should use the exported filter helpers from
@backblaze-labs/b2-sdk/sync to stay aligned with the SDK glob and RegExp dialect.
ReadonlyappliesTrue when scan(filters) already yields entries in compareSyncRelativePaths order.
Custom folders that omit this are sorted by synchronize() before pairing.
ReadonlyrootResolved absolute path to the local root directory.
ReadonlytypeWhether this folder is local or in B2.
Recursively walks the directory and yields files in sync path order.
Optional scan controls.
Scans a local directory tree and yields LocalSyncPath entries sorted by relative path. A root directory read failure aborts the scan with an error diagnostic. Per-entry file or directory failures are reported through
onErrorand the scan continues over readable siblings. SDK-managed partial download file names are skipped so unfinished internal temp files are not synchronized. The current implementation collects matching entries before sorting, so memory usage is proportional to the number of matched files.