Skip to content

TransferPlanInput

Defined in: src/transfers/TransferPlan.ts:32

Input used to create a transfer plan.

PropertyTypeDescriptionDefined in
dryRun?booleanWhether the plan is informational only. Defaults to true.src/transfers/TransferPlan.ts:38
idstringStable plan identifier.src/transfers/TransferPlan.ts:34
metadata?Record<string, unknown>Caller-defined metadata retained for diagnostics.src/transfers/TransferPlan.ts:44
now?() => DateClock used for deterministic tests. Defaults to new Date().src/transfers/TransferPlan.ts:40
stepsTransferPlanStep[]Planned steps in execution order.src/transfers/TransferPlan.ts:36
warnings?string[]Non-fatal plan warnings.src/transfers/TransferPlan.ts:42