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

    Interface B2SyncFolder

    A sync folder constrained to a B2 bucket prefix.

    interface B2SyncFolder {
        appliesScanFilters?: true;
        appliesScanSorting?: true;
        rawPrefix?: string;
        type: "b2";
        scan(options?: SyncScanOptions): AsyncIterable<SyncPath>;
    }

    Hierarchy (View Summary)

    Index

    Properties

    appliesScanFilters? appliesScanSorting? rawPrefix? type

    Methods

    scan

    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.

    rawPrefix?: string

    Raw B2 key prefix represented by this folder when known.

    type: "b2"

    Discriminant identifying a B2 folder.

    Methods

    Settings

    Member Visibility

    On This Page

    Properties
    Methods