createTransferPlan

function createTransferPlan(input: TransferPlanInput): TransferPlan;

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

Creates a transfer plan from dry-run planning input.

Plans are immutable, structured descriptions of intended work. Pair with createSyncPlan or createAtomicDeployPlan for end-to-end planning, or build steps by hand when you need full control. Pass the plan to createTransferJobsFromPlan to materialize executable jobs.

Parameters

Parameter	Type
input	TransferPlanInput

Returns

TransferPlan

Example

import { createTransferPlan, summarizeTransferPlan } from "@zero-transfer/sdk";

const plan = createTransferPlan({
  id: "manual-batch",
  steps: [
    { action: "upload", source: "./a.bin", destination: "/lake/a.bin", expectedBytes: 1024 },
    { action: "upload", source: "./b.bin", destination: "/lake/b.bin", expectedBytes: 2048 },
  ],
});

console.table(summarizeTransferPlan(plan));