Skip to main content

StockDisplayStrategy

StockDisplayStrategy​

@vendure/corestock-display-strategy.ts

Defines how the ProductVariant.stockLevel value is obtained. It is usually not desirable to directly expose stock levels over a public API, as this could be considered a leak of sensitive information. However, the storefront will usually want to display some indication of whether a given ProductVariant is in stock.

info

This is configured via the catalogOptions.stockDisplayStrategy property of your VendureConfig.

Signature
interface StockDisplayStrategy extends InjectableStrategy {
    getStockLevel(
        ctx: RequestContext,
        productVariant: ProductVariant,
        saleableStockLevel: number,
    ): string | Promise<string>;
}

getStockLevel​

method
(ctx: RequestContext, productVariant: ProductVariant, saleableStockLevel: number) => string | Promise<string>

Returns a string representing the stock level, which will be used directly in the GraphQL ProductVariant.stockLevel field.