Interface ActionFactory

Factory for creating concrete sync actions. Used by generateActions to decouple policy from execution.

interface ActionFactory {
    copy(source: B2SyncPath, destPath: string): SyncAction;
    deleteLocal(path: LocalSyncPath): SyncAction;
    deleteRemote(path: B2SyncPath): SyncAction;
    download(source: B2SyncPath): SyncAction;
    hide(path: string): SyncAction;
    removeOrphan(dest: B2SyncPath): SyncAction;
    upload(source: LocalSyncPath): SyncAction;
}

Index

Methods

copy deleteLocal deleteRemote download hide removeOrphan upload

Methods

copy

copy(source: B2SyncPath, destPath: string): SyncAction
Creates an action to server-side copy a B2 file to a new destination path.
Parameters
- source: B2SyncPath
- destPath: string
Returns SyncAction
- Defined in sync/policies/index.ts:21

deleteLocal

deleteLocal(path: LocalSyncPath): SyncAction
Creates an action to delete a local file.
Parameters
- path: LocalSyncPath
Returns SyncAction
- Defined in sync/policies/index.ts:27

deleteRemote

deleteRemote(path: B2SyncPath): SyncAction
Creates an action to permanently delete a remote B2 file version.
Parameters
- path: B2SyncPath
Returns SyncAction
- Defined in sync/policies/index.ts:25

download

download(source: B2SyncPath): SyncAction
Creates an action to download a B2 file to the local filesystem.
Parameters
- source: B2SyncPath
Returns SyncAction
- Defined in sync/policies/index.ts:19

hide

hide(path: string): SyncAction
Creates an action to hide a file in B2 (soft delete).
Parameters
- path: string
Returns SyncAction
- Defined in sync/policies/index.ts:23

removeOrphan

removeOrphan(dest: B2SyncPath): SyncAction
Creates the right "remove this orphan from B2" action for the bucket's configuration: a hide on a file-lock-enabled bucket (where direct delete may be blocked or stack hide markers), a plain delete-file-version on a vanilla bucket. Used by actionsForDestOnly to avoid yielding both a hide AND a delete when only one of them is the correct semantic for the destination bucket.
Parameters
- dest: B2SyncPath
Returns SyncAction
- Defined in sync/policies/index.ts:36

upload

upload(source: LocalSyncPath): SyncAction
Creates an action to upload a local file to B2.
Parameters
- source: LocalSyncPath
Returns SyncAction
- Defined in sync/policies/index.ts:17