FacetValueChecker

FacetValueChecker

FacetValueChecker

The FacetValueChecker is a helper class used to determine whether a given OrderLine consists of ProductVariants containing the given FacetValues.

Example

import { FacetValueChecker, LanguageCode, PromotionCondition, TransactionalConnection } from '@vendure/core';

let facetValueChecker: FacetValueChecker;

export const hasFacetValues = new PromotionCondition({
  code: 'at_least_n_with_facets',
  description: [
    { languageCode: LanguageCode.en, value: 'Buy at least { minimum } products with the given facets' },
  ],
  args: {
    minimum: { type: 'int' },
    facets: { type: 'ID', list: true, ui: { component: 'facet-value-form-input' } },
  },
  init(injector) {
    facetValueChecker = new FacetValueChecker(injector.get(TransactionalConnection));
  },
  // tslint:disable-next-line:no-shadowed-variable
  async check(ctx, order, args) {
    let matches = 0;
    for (const line of order.lines) {
      if (await facetValueChecker.hasFacetValues(line, args.facets)) {
          matches += line.quantity;
      }
    }
    return args.minimum <= matches;
  },
});

Signature

class FacetValueChecker {
  constructor(connection: TransactionalConnection)
  async hasFacetValues(orderLine: OrderLine, facetValueIds: ID[]) => Promise<boolean>;
}

Members

constructor

method
type:
(connection: TransactionalConnection) => FacetValueChecker

hasFacetValues

async method
type:
(orderLine: OrderLine, facetValueIds: ID[]) => Promise<boolean>
Checks a given OrderLine against the facetValueIds and returns true if the associated ProductVariant & Product together have all the specified FacetValues.