isCanceledSingleTransactionPlanResult

function isCanceledSingleTransactionPlanResult(
    plan,
): plan is CanceledSingleTransactionPlanResult;

Checks if the given transaction plan result is a canceled SingleTransactionPlanResult.

Parameters

ParameterTypeDescription
planTransactionPlanResultThe transaction plan result to check.

Returns

plan is CanceledSingleTransactionPlanResult

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

Example

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

See

On this page