Skip to main content

SyncTaskOptions


Nadle / SyncTaskOptions

Interface: SyncTaskOptions

Defined in: packages/nadle/src/builtin-tasks/sync-task.ts:16

Options for the SyncTask.

Extends

Properties

exclude?

readonly optional exclude?: MaybeArray<string>

Defined in: packages/nadle/src/builtin-tasks/file-operations.ts:24

Default exclude patterns for directory selections without their own.

Inherited from

FileOperationOptions.exclude


flatten?

readonly optional flatten?: boolean

Defined in: packages/nadle/src/builtin-tasks/file-operations.ts:20

Place all files directly into into, dropping source directory structure.

Inherited from

FileOperationOptions.flatten


from

readonly from: MaybeArray<FileSelection>

Defined in: packages/nadle/src/builtin-tasks/file-operations.ts:26

Source file(s), directory(ies), or selector(s) with glob patterns.

Inherited from

FileOperationOptions.from


include?

readonly optional include?: MaybeArray<string>

Defined in: packages/nadle/src/builtin-tasks/file-operations.ts:22

Default include patterns for directory selections without their own.

Inherited from

FileOperationOptions.include


into

readonly into: string

Defined in: packages/nadle/src/builtin-tasks/file-operations.ts:16

Destination directory. Created if missing.

Inherited from

FileOperationOptions.into


preserve?

readonly optional preserve?: MaybeArray<string>

Defined in: packages/nadle/src/builtin-tasks/sync-task.ts:18

Glob patterns (relative to into) for files that are never deleted.


rename?

readonly optional rename?: Record<string, string>

Defined in: packages/nadle/src/builtin-tasks/file-operations.ts:28

Renames by exact base name, e.g. { "config.dev.json": "config.json" }.

Inherited from

FileOperationOptions.rename


strict?

readonly optional strict?: boolean

Defined in: packages/nadle/src/builtin-tasks/file-operations.ts:18

Fail when a source path is missing or no files match. Defaults to false.

Inherited from

FileOperationOptions.strict