isTransactionPlan

function isTransactionPlan(value): value is TransactionPlan;

Checks if the given value is a TransactionPlan.

This type guard checks the planType property to determine if the value is a transaction plan. This is useful when you have a value that could be an InstructionPlan, TransactionPlan, or TransactionPlanResult and need to narrow the type.

Parameters

Returns

value is TransactionPlan

true if the value is a transaction plan, false otherwise.

Example

function processItem(item: InstructionPlan | TransactionPlan | TransactionPlanResult) {
  if (isTransactionPlan(item)) {
    // item is narrowed to TransactionPlan
    console.log(item.kind);
  }
}

See

• TransactionPlan
• isInstructionPlan
• isTransactionPlanResult