SequentialTransactionPlanResult

type SequentialTransactionPlanResult<TContext> = Readonly<{
  divisible: boolean;
  kind: "sequential";
  plans: TransactionPlanResult<TContext>[];
}>;

A result for a sequential transaction plan.

This represents the execution result of a SequentialTransactionPlan and contains child results that were executed sequentially. It also retains the divisibility property from the original plan.

You may use the sequentialTransactionPlanResult and nonDivisibleSequentialTransactionPlanResult helpers to create objects of this type.

Type Parameters

Type ParameterDefault typeDescription
TContext extends TransactionPlanResultContextTransactionPlanResultContextThe type of the context object that may be passed along with successful results

Examples

const result = sequentialTransactionPlanResult([
  singleResultA,
  singleResultB,
]);
result satisfies SequentialTransactionPlanResult;

Non-divisible sequential result.

const result = nonDivisibleSequentialTransactionPlanResult([
  singleResultA,
  singleResultB,
]);
result satisfies SequentialTransactionPlanResult & { divisible: false };

See

On this page