PromotionCondition

PromotionCondition

Package: @vendure/core File: promotion-condition.ts

PromotionConditions are used to create Promotions. The purpose of a PromotionCondition is to check the order against a particular predicate function (the check function) and to return true if the Order satisfies the condition, or false if it does not.

Signature

class PromotionCondition<T extends PromotionConditionArgs = {}> implements ConfigurableOperationDef {
  readonly readonly code: string;
  readonly readonly description: string;
  readonly readonly args: PromotionConditionArgs;
  readonly readonly priorityValue: number;
  constructor(config: {
        args: T;
        check: CheckPromotionConditionFn<T>;
        code: string;
        description: string;
        priorityValue?: number;
    })
  async check(order: Order, args: ConfigArg[], utils: PromotionUtils) => Promise<boolean>;
}

Members

code

readonly property

type:

string

description

readonly property

type:

string

args

readonly property

type:

PromotionConditionArgs

priorityValue

readonly property

type:

number

constructor

method

type:

(config: {         args: T;         check: CheckPromotionConditionFn<T>;         code: string;         description: string;         priorityValue?: number;     }) => PromotionCondition

check

async method

type:

(order: Order, args: ConfigArg[], utils: PromotionUtils) => Promise<boolean>