assertIsParallelTransactionPlan

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

Asserts that the given transaction plan is a ParallelTransactionPlan.

Parameters

ParameterTypeDescription
planTransactionPlanThe transaction plan to assert.

Returns

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

Throws

Throws a SolanaError with code SOLANA_ERROR__INSTRUCTION_PLANS__UNEXPECTED_TRANSACTION_PLAN if the plan is not a parallel transaction plan.

Example

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

See

On this page