Optional 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.
Optional ReadonlyappliesTrue when scan(filters) already yields entries in compareSyncRelativePaths order.
Custom folders that omit this are sorted by synchronize() before pairing.
ReadonlytypeWhether this folder is local or in B2.
Scans the folder and yields files relative to the folder root.
Optionaloptions: SyncScanOptions
A scannable folder (local or B2) that yields files relative to its sync root.
Built-in scanners currently sort before yielding. Large local trees or B2 prefixes may therefore require memory proportional to the scanned entries; B2 scans also group listed versions before yielding. For B2,
maxScanEntriescounts every listed file version before prefix, safety, and filter checks, and exclude filters or non-literal includes do not bound B2 listing calls.