isFailedSingleTransactionPlanResult

function isFailedSingleTransactionPlanResult<
    TContext,
    TTransactionMessage,
>(
    plan,
): plan is FailedSingleTransactionPlanResult<
    TContext,
    TTransactionMessage
>;

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

Type Parameters

Type ParameterDefault type
TContext extends TransactionPlanResultContextTransactionPlanResultContext
TTransactionMessage extends TransactionMessage & TransactionMessageWithFeePayer<string>TransactionMessage & TransactionMessageWithFeePayer<string>

Parameters

ParameterTypeDescription
planTransactionPlanResult<TContext, TTransactionMessage>The transaction plan result to check.

Returns

plan is FailedSingleTransactionPlanResult<TContext, TTransactionMessage>

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

Example

const result: TransactionPlanResult = failedSingleTransactionPlanResult(message, error);
 
if (isFailedSingleTransactionPlanResult(result)) {
  console.log(result.error); // TypeScript knows this is a failed result.
}

See

On this page