isSequentialTransactionPlanResult

function isSequentialTransactionPlanResult(
    plan,
): plan is Readonly<{
    divisible: boolean;
    kind: 'sequential';
    plans: TransactionPlanResult<
        TransactionPlanResultContext,
        Readonly<{
            kind: 'single';
            message: TransactionMessage &
                TransactionMessageWithFeePayer<string>;
            status: TransactionPlanResultStatus<TransactionPlanResultContext>;
        }>
    >[];
}>;

Checks if the given transaction plan result is a SequentialTransactionPlanResult.

Parameters

ParameterTypeDescription
planTransactionPlanResultThe transaction plan result to check.

Returns

plan is Readonly<{ divisible: boolean; kind: "sequential"; plans: TransactionPlanResult<TransactionPlanResultContext, Readonly<{ kind: "single"; message: TransactionMessage & TransactionMessageWithFeePayer<string>; status: TransactionPlanResultStatus<TransactionPlanResultContext> }>>[] }>

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