Function variantSeriesKey

variantSeriesKey(product: Product, variant: Variant): undefined | string

Derive the series id for one of a product's variants: the product key joined with the variant's discriminator (see variantDiscriminator).

Parameters

product: Product
The parent product (provides the shared product key).
variant: Variant
The variant to key.

Returns undefined | string

The variant series id, or undefined when the product can't be keyed or the variant has no discriminator.

Example

variantSeriesKey(product, { id: "d5de5c76", cacheKey: "96a50af4" }); // "3f9c2a…::d5de5c76"

Source

export function variantSeriesKey(product: Product, variant: Variant): string | undefined {
  const productKey = productSeriesKey(product);
  if (productKey === undefined) {
    return undefined;
  }
  const discriminator = variantDiscriminator(product, variant);
  if (discriminator === undefined) {
    return undefined;
  }
  return `${productKey}::${discriminator}`;
}