Optional ReadonlyexcludeOptional deny-list. Paths matching any exclude pattern are skipped even when they also match an include pattern. Excludes are client-side filters; they do not reduce B2 list API calls or the B2 scanner's version grouping and sort memory.
Optional ReadonlyincludeOptional allow-list. When present, only paths matching at least one pattern are scanned. B2 scans can push down only the safe literal prefix from slash-containing glob includes; other include filtering is client-side.
Optional ReadonlymaxMaximum number of entries a scanner may retain before failing with a defined error instead of continuing toward unbounded heap growth. Defaults to the SDK scan limit.
Optional ReadonlyonReceives scan diagnostics. Built-in scanners may continue after recoverable per-path diagnostics, such as unreadable local children, but fatal scan failures still abort.
Optional ReadonlyonReceives scanner skip diagnostics. Built-in scans isolate callback errors so diagnostics handlers cannot abort the scan.
Optional ReadonlyrequireWhen true, B2 scanners skip names that cannot be written safely to a local filesystem destination and reject case/Unicode-canonical local path collisions.
Optional ReadonlysignalOptional signal checked by built-in scanners while enumerating. Aborting stops local traversal promptly and stops B2 scans before requesting the next page.
Options accepted by SyncFolder.scan. Includes filters plus an optional scan-level callback for paths the scanner cannot safely represent or test.