assertIsSingleTransactionPlanResult

function assertIsSingleTransactionPlanResult<
    TContext,
    TTransactionMessage,
    TSingle,
>(plan): asserts plan is TSingle;

Asserts that the given transaction plan result is a SingleTransactionPlanResult.

Type Parameters

Type Parameter	Default type
`TContext` extends `TransactionPlanResultContext`	`TransactionPlanResultContext`
`TTransactionMessage` extends `TransactionMessage` & `TransactionMessageWithFeePayer`<`string`>	`TransactionMessage` & `TransactionMessageWithFeePayer`<`string`>
`TSingle` extends `Readonly`<{ `kind`: `"single"`; `message`: `TTransactionMessage`; `status`: `TransactionPlanResultStatus`<`TContext`>; }>	`Readonly`<{ `kind`: `"single"`; `message`: `TTransactionMessage`; `status`: `TransactionPlanResultStatus`<`TContext`>; }>

Parameters

Parameter	Type	Description
`plan`	`TransactionPlanResult`<`TContext`, `TTransactionMessage`, `TSingle`>	The transaction plan result to assert.

Returns

asserts plan is TSingle

Throws

Throws a SolanaError with code SOLANA_ERROR__INSTRUCTION_PLANS__UNEXPECTED_TRANSACTION_PLAN_RESULT if the result is not a single transaction plan result.

Example

const result: TransactionPlanResult = successfulSingleTransactionPlanResult(message, transaction);
 
assertIsSingleTransactionPlanResult(result);
console.log(result.status.kind); // TypeScript knows this is a SingleTransactionPlanResult.