isSequentialTransactionPlanResult

function isSequentialTransactionPlanResult<
    TContext,
    TTransactionMessage,
    TSingle,
>(
    plan,
): plan is Readonly<{
    divisible: boolean;
    kind: 'sequential';
    plans: TransactionPlanResult<
        TContext,
        TTransactionMessage,
        TSingle
    >[];
}>;

Checks if the given transaction plan result is a SequentialTransactionPlanResult.

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 Readonly<{ divisible: boolean; kind: "sequential"; plans: TransactionPlanResult<TContext, TTransactionMessage, TSingle>[] }>

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

Example

const result: TransactionPlanResult = sequentialTransactionPlanResult([resultA, resultB]);
 
if (isSequentialTransactionPlanResult(result)) {
  console.log(result.divisible); // TypeScript knows this is a SequentialTransactionPlanResult.
}

See

On this page