Class Discountler

The Discountler is the primary utility for interfacing with discounts. You should instantiate a singleton instance for the whole app to gain the benefits of internal caching.

Hierarchy

Discountler

Index

Constructors

Properties

Methods

getActiveDiscountGroups getCache getCustomerDiscounter getEligibleDiscountGroups reconstructDiscounter

Constructors

constructor

new Discountler(): Discountler
Returns Discountler

Properties

`Optional` cache

cache?: MemoryCache

Methods

`Private` getActiveDiscountGroups

getActiveDiscountGroups(): Promise<CustomerDiscountGroup[]>
Returns Promise<CustomerDiscountGroup[]>
- Defined in src/Discountler.ts:24

`Private` getCache

getCache(): Promise<MemoryCache>
Returns Promise<MemoryCache>
- Defined in src/Discountler.ts:14

getCustomerDiscounter

getCustomerDiscounter(customerContext?: CustomerDiscountContext): Promise<undefined | CustomerDiscounter>
Parameters
- Optional customerContext: CustomerDiscountContext
Returns Promise<undefined | CustomerDiscounter>
- Defined in src/Discountler.ts:144

`Private` getEligibleDiscountGroups

getEligibleDiscountGroups(__namedParameters?: CustomerDiscountContext): Promise<CustomerDiscountGroup[]>
Parameters
- __namedParameters: CustomerDiscountContext = {}
Returns Promise<CustomerDiscountGroup[]>
- Defined in src/Discountler.ts:31

reconstructDiscounter

reconstructDiscounter(cacheKey?: string): Promise<undefined | CustomerDiscounter>
Parameters
- Optional cacheKey: string
Returns Promise<undefined | CustomerDiscounter>
- Defined in src/Discountler.ts:156

Generated using TypeDoc