@backblaze-labs/b2-sdk - v0.2.0
    Preparing search index...

    Interface LocalSyncFolder

    A sync folder constrained to the local filesystem.

    interface LocalSyncFolder {
        appliesScanFilters?: true;
        appliesScanSorting?: true;
        root: string;
        type: "local";
        scan(options?: SyncScanOptions): AsyncIterable<SyncPath>;
    }

    Hierarchy (View Summary)

    Index

    Properties

    appliesScanFilters?: true

    True 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.

    appliesScanSorting?: true

    True when scan(filters) already yields entries in compareSyncRelativePaths order. Custom folders that omit this are sorted by synchronize() before pairing.

    root: string

    Absolute filesystem path to the local root directory.

    type: "local"

    Discriminant identifying a local folder.

    Methods