Class CustomerDiscounter

The CustomerDiscounter holds the main logic for calculating customer-specific discounts. However, you probably do not want to instantiate one of these directly. Instead, use your instantiated Discountler to generate a CustomerDiscounter instance specific to the customer in question.

Hierarchy

CustomerDiscounter

Constructors

constructor

new CustomerDiscounter(config: {
discountGroups: CustomerDiscountGroup[];
}): CustomerDiscounter
Parameters
- config: {
  discountGroups: CustomerDiscountGroup[];
  }
  - discountGroups: CustomerDiscountGroup[]
Returns CustomerDiscounter
- Defined in src/CustomerDiscounter.ts:33

Properties

`Readonly` analyticsProperties

analyticsProperties: Readonly<Properties>

`Private` `Readonly` config

config: {
discountGroups: CustomerDiscountGroup[];
}

Type declaration

discountGroups: CustomerDiscountGroup[]

`Readonly` customerProperties

customerProperties: Readonly<Properties>

`Readonly` discountGroupIds

discountGroupIds: number[]

`Readonly` discounts

discounts: Readonly<Discount>[]

`Readonly` equivalentCustomerTags

equivalentCustomerTags: string[]

`Readonly` hasActiveSale

hasActiveSale: boolean

`Readonly` itemProperties

itemProperties: Readonly<Properties>

`Readonly` largestDiscountPercentage

largestDiscountPercentage: number

`Readonly` largestSaleDiscountPercentage

largestSaleDiscountPercentage: number

`Readonly` orderProperties

orderProperties: Readonly<Properties>

`Readonly` orderTags

orderTags: string[]

`Readonly` saleDiscounts

saleDiscounts: Readonly<Discount>[]

Accessors

cacheKey

get cacheKey(): string
Returns string
- Defined in src/CustomerDiscounter.ts:121

Methods

getDiscount

getDiscount(__namedParameters?: {
tags?: string[];
}): undefined | Readonly<Discount>
Parameters
- __namedParameters: {
  tags?: string[];
  } = {}
  - Optional tags?: string[]
Returns undefined | Readonly<Discount>
- Defined in src/CustomerDiscounter.ts:180

getItemDiscountProperties

getItemDiscountProperties(product?: {
tags?: string[];
}): ItemDiscountProperties
Parameters
- product: {
  tags?: string[];
  } = {}
  - Optional tags?: string[]
Returns ItemDiscountProperties
- Defined in src/CustomerDiscounter.ts:203

getProductDiscount

getProductDiscount(product?: {
tags?: string[];
}): number
Deprecated
For backwards compatibility
Parameters
- Optional product: {
  tags?: string[];
  }
  - Optional tags?: string[]
Returns number
- Defined in src/CustomerDiscounter.ts:218

productIsValid

productIsValid(product?: {
tags?: string[];
}): boolean
Deprecated
For backwards compatibility
Parameters
- Optional product: {
  tags?: string[];
  }
  - Optional tags?: string[]
Returns boolean
- Defined in src/CustomerDiscounter.ts:226

`Static` fromCacheKey

fromCacheKey(__namedParameters: {
cacheKey: string;
discountGroups: CustomerDiscountGroup[];
}): undefined | CustomerDiscounter
Parameters
- __namedParameters: {
  cacheKey: string;
  discountGroups: CustomerDiscountGroup[];
  }
  - cacheKey: string
  - discountGroups: CustomerDiscountGroup[]
Returns undefined | CustomerDiscounter
- Defined in src/CustomerDiscounter.ts:132

Class CustomerDiscounter

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

config: { discountGroups: CustomerDiscountGroup[]; }

discountGroups: CustomerDiscountGroup[]

Returns CustomerDiscounter

Properties

Readonly analyticsProperties

Private Readonly config

Type declaration

discountGroups: CustomerDiscountGroup[]

Readonly customerProperties

Readonly discountGroupIds

Readonly discounts

Readonly equivalentCustomerTags

Readonly hasActiveSale

Readonly itemProperties

Readonly largestDiscountPercentage

Readonly largestSaleDiscountPercentage

Readonly orderProperties

Readonly orderTags

Readonly saleDiscounts

Accessors

cacheKey

Returns string

Methods

getDiscount

Parameters

__namedParameters: { tags?: string[]; } = {}

Optional tags?: string[]

Returns undefined | Readonly<Discount>

getItemDiscountProperties

Parameters

product: { tags?: string[]; } = {}

Optional tags?: string[]

Returns ItemDiscountProperties

getProductDiscount

Deprecated

Parameters

Optional product: { tags?: string[]; }

Optional tags?: string[]

Returns number

productIsValid

Deprecated

Parameters

Optional product: { tags?: string[]; }

Optional tags?: string[]

Returns boolean

Static fromCacheKey

Parameters

__namedParameters: { cacheKey: string; discountGroups: CustomerDiscountGroup[]; }

cacheKey: string

discountGroups: CustomerDiscountGroup[]

Returns undefined | CustomerDiscounter

Settings

Member Visibility

Theme

config: {
discountGroups: CustomerDiscountGroup[];
}

`Readonly` analyticsProperties

`Private` `Readonly` config

`Readonly` customerProperties

`Readonly` discountGroupIds

`Readonly` discounts

`Readonly` equivalentCustomerTags

`Readonly` hasActiveSale

`Readonly` itemProperties

`Readonly` largestDiscountPercentage

`Readonly` largestSaleDiscountPercentage

`Readonly` orderProperties

`Readonly` orderTags

`Readonly` saleDiscounts

__namedParameters: {
tags?: string[];
} = {}

`Optional` tags?: string[]

product: {
tags?: string[];
} = {}

`Optional` tags?: string[]

`Optional` product: {
tags?: string[];
}

`Optional` tags?: string[]

`Optional` product: {
tags?: string[];
}

`Optional` tags?: string[]

`Static` fromCacheKey

__namedParameters: {
cacheKey: string;
discountGroups: CustomerDiscountGroup[];
}