assertIsCanceledSingleTransactionPlanResult

function assertIsCanceledSingleTransactionPlanResult(
    plan,
): asserts plan is CanceledSingleTransactionPlanResult;

Asserts that the given transaction plan result is a canceled SingleTransactionPlanResult.

Parameters

ParameterTypeDescription
planTransactionPlanResultThe transaction plan result to assert.

Returns

asserts plan is CanceledSingleTransactionPlanResult

Throws

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

Example

const result: TransactionPlanResult = canceledSingleTransactionPlanResult(message);
 
assertIsCanceledSingleTransactionPlanResult(result);
console.log('Transaction was canceled'); // TypeScript knows this is a canceled result.

See

On this page