Options
Menu

ConfigFile Interface

Options that may be specified in the config file

Hierarchy

Index

File Provider Properties

Other Properties

sync Properties

File Provider Properties

origin

origin: ProviderOptionsWithIgnores

If undefined, CWD is used as the root

target

target: ProviderOptionsWithIgnores

Other Properties

Optional delegate

delegate: CliDelegate

Optionally define a delegate object to override internal CLI implementations

Optional json

json: undefined | false | true

Render output as JSON

default

false

Optional limitRequests

limitRequests: number | false

Max parallel list/put/copy/delete operations

default

3

Optional onLog

onLog: LogMessageHandler

If defined, this function is called for each log message

default

undefined

schemaVersion

schemaVersion: number

Should always be 2

Optional showHashes

showHashes: undefined | false | true

If true, display ETag property for File(s)

remarks

No effect on sync command when --json is false

default

false

Optional showIgnored

showIgnored: undefined | false | true

If true, display ignored files

default

false

sync Properties

Optional compare

compare: FilePairHandler<Promise<boolean>> | false
  • If a function is provided, it should return a Promise that resolves to false if originFile has changed
  • If false is provided, all non-ignored files will be uploaded (assume all files have changed)
  • If undefined is provided, the default comparator will be used (ETag properties must be equal)
remarks

Only relevant to sync command

default

undefined

Optional delete

delete: undefined | false | true

If true, delete target files that do not exist in origin

remarks

Only relevant to sync command

default

false

Optional expect

expect: undefined | false | true

If true, only upload origin files that already exist in target

remarks

Only relevant to sync command

default

true

Optional go

go: undefined | false | true
  • If true, preview and perform operations without prompting (-y, --go)
  • If false, preview operations without performing them or prompting (-n, --no-go)
  • If undefined, preview operations and prompt to confirm before performing
remarks

Only relevant to sync command

default

undefined

Optional limitCompares

limitCompares: number | false

Max parallel file compare operations

remarks

Only relevant to sync command

default

10

Optional showParams

showParams: undefined | false | true

If true, display operation request parameters

remarks

Only relevant to sync command

default

false

Optional showSkipped

showSkipped: undefined | false | true

If true, display skipped (unchanged/unexpected) files

remarks

Only relevant to sync command

default

false

Generated using TypeDoc