summarizeTransferPlan

function summarizeTransferPlan(plan: TransferPlan): TransferPlanSummary;

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

Summarizes a transfer plan for diagnostics, previews, and tests.

Returns aggregate counts (total / executable / skipped / destructive), total expected bytes, and a per-action histogram. Useful for printing a one-line plan summary before executing or for asserting plan shape in tests.

Parameters

Parameter	Type
plan	TransferPlan

Returns

TransferPlanSummary

Example

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

const summary = summarizeTransferPlan(plan);
console.log(`${summary.executableSteps} steps, ${summary.totalExpectedBytes} bytes total`);
console.log("Actions:", summary.actions);