default-stock-display-strategy.md

title	isDefaultIndex	generated
DefaultStockDisplayStrategy	false	true

import MemberInfo from '@site/src/components/MemberInfo'; import GenerationInfo from '@site/src/components/GenerationInfo'; import MemberDescription from '@site/src/components/MemberDescription';

DefaultStockDisplayStrategy

Displays the ProductVariant.stockLevel as either 'IN_STOCK', 'OUT_OF_STOCK' or 'LOW_STOCK'. Low stock is defined as a saleable stock level less than or equal to the lowStockLevel as passed in to the constructor (defaults to 2).

class DefaultStockDisplayStrategy implements StockDisplayStrategy {
    constructor(lowStockLevel: number = 2)
    getStockLevel(ctx: RequestContext, productVariant: ProductVariant, saleableStockLevel: number) => string;
}

• Implements: StockDisplayStrategy

constructor

<MemberInfo kind="method" type={(lowStockLevel: number = 2) => DefaultStockDisplayStrategy} />

getStockLevel

<MemberInfo kind="method" type={(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, productVariant: <a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a>, saleableStockLevel: number) => string} />