isParallelTransactionPlan

function isParallelTransactionPlan(
    plan,
): plan is Readonly<{
    kind: 'parallel';
    plans: TransactionPlan[];
    planType: 'transactionPlan';
}>;

Checks if the given transaction plan is a ParallelTransactionPlan.

Parameters

Parameter	Type	Description
`plan`	`TransactionPlan`	The transaction plan to check.

Returns

plan is Readonly<{ kind: "parallel"; plans: TransactionPlan[]; planType: "transactionPlan" }>

true if the plan is a parallel transaction plan, false otherwise.

Example

const plan: TransactionPlan = parallelTransactionPlan([messageA, messageB]);
 
if (isParallelTransactionPlan(plan)) {
  console.log(plan.plans.length); // TypeScript knows this is a ParallelTransactionPlan.
}

See