isSingleInstructionPlan

function isSingleInstructionPlan(
    plan,
): plan is Readonly<{
    instruction: Instruction;
    kind: 'single';
    planType: 'instructionPlan';
}>;

Checks if the given instruction plan is a SingleInstructionPlan.

Parameters

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

Returns

plan is Readonly<{ instruction: Instruction; kind: "single"; planType: "instructionPlan" }>

true if the plan is a single instruction plan, false otherwise.

Example

const plan: InstructionPlan = singleInstructionPlan(myInstruction);
 
if (isSingleInstructionPlan(plan)) {
  console.log(plan.instruction); // TypeScript knows this is a SingleInstructionPlan.
}

See