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

    Interface SyncAction

    A single executable sync action produced by the policy engine.

    interface SyncAction {
        relativePath: string;
        size: number;
        type: SyncActionType;
        execute(dryRun: boolean, signal?: AbortSignal): Promise<SyncEvent>;
    }

    Implemented by

    Index

    Properties

    relativePath size type

    Methods

    execute

    Properties

    relativePath: string

    Relative path of the file this action targets.

    size: number

    Size in bytes of the file, or 0 for metadata-only actions.

    type: SyncActionType

    The kind of action.

    Methods

    • Executes the action (or no-ops if dryRun is true) and returns a corresponding event.

      Parameters

      • dryRun: boolean

        When true, skip the actual I/O but still return the event.

      • Optionalsignal: AbortSignal

        Optional abort signal for canceling in-flight I/O.

      Returns Promise<SyncEvent>

    Settings

    Member Visibility

    On This Page

    Properties
    Methods