isSingleTransactionPlanResult

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

Checks if the given transaction plan result is a SingleTransactionPlanResult.

Type Parameters

Type ParameterDefault type
TContext extends TransactionPlanResultContextTransactionPlanResultContext
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

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

Returns

plan is TSingle

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

Example

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

See

On this page