vaultmd / TransformOpts

Type Alias: TransformOpts

TransformOpts = object

Defined in: src/locked-file/models/transform-opts.ts:5

Options for withFileTransform.

Properties

allowCreate?

optional allowCreate?: boolean

Defined in: src/locked-file/models/transform-opts.ts:11

When true, the transform may create the file if it does not yet exist. Defaults to false — an attempt to write a new file throws MdVaultError('REFUSE_CREATE').

---

cross?

optional cross?: CrossLock | false

Defined in: src/locked-file/models/transform-opts.ts:27

Cross-process lock configuration. Pass a CrossLock to serialise writes across multiple processes; pass false (default) to use only the in-process lock.

---

maxRetries?

optional maxRetries?: number

Defined in: src/locked-file/models/transform-opts.ts:21

Maximum number of optimistic-concurrency retries on MTIME_CONFLICT before the conflict error is re-thrown (default 3).

---

onCommit?

optional onCommit?: (e) => void | Promise<void>

Defined in: src/locked-file/models/transform-opts.ts:16

Optional callback invoked after a successful write or create. Receives a CommitEvent describing the operation and new content.

Parameters

e

CommitEvent

Returns

void | Promise<void>