isNonDivisibleSequentialInstructionPlan

function isNonDivisibleSequentialInstructionPlan(
    plan,
): plan is Readonly<{
    divisible: boolean;
    kind: 'sequential';
    plans: InstructionPlan[];
    planType: 'instructionPlan';
}> & { divisible: false };

Checks if the given instruction plan is a non-divisible SequentialInstructionPlan.

A non-divisible sequential plan requires all its instructions to be executed atomically — either in a single transaction or in a transaction bundle.

Parameters

Parameter	Type	Description
`plan`	`InstructionPlan`	The instruction plan to check.

Returns

plan is Readonly<{ divisible: boolean; kind: "sequential"; plans: InstructionPlan[]; planType: "instructionPlan" }> & { divisible: false }

true if the plan is a non-divisible sequential instruction plan, false otherwise.

Example

const plan: InstructionPlan = nonDivisibleSequentialInstructionPlan([instructionA, instructionB]);
 
if (isNonDivisibleSequentialInstructionPlan(plan)) {
  // All instructions must be executed atomically.
}

See