isSingleTransactionPlan

function isSingleTransactionPlan(
    plan,
): plan is Readonly<{
    kind: 'single';
    message: TransactionMessage &
        TransactionMessageWithFeePayer<string>;
    planType: 'transactionPlan';
}>;

Checks if the given transaction plan is a SingleTransactionPlan.

Parameters

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

Returns

plan is Readonly<{ kind: "single"; message: TransactionMessage & TransactionMessageWithFeePayer<string>; planType: "transactionPlan" }>

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

Example

const plan: TransactionPlan = singleTransactionPlan(transactionMessage);
 
if (isSingleTransactionPlan(plan)) {
  console.log(plan.message); // TypeScript knows this is a SingleTransactionPlan.
}

See