Home > widget-integration > FilterHelper > convertValueRequestStockStatus

FilterHelper.convertValueRequestStockStatus() method

Converts stock status values for API requests.

Transforms stock status filter values into boolean format for the API. Converts 'out-of-stock' to false and all other values to true. Handles both single values and arrays. Override this method to customize stock status conversion logic for shop-specific requirements.

Signature:

protected convertValueRequestStockStatus(value: any): boolean | boolean[];

Parameters

Returns:

boolean | boolean[]

Boolean value(s) where false = out-of-stock, true = in-stock

Example

Extend to support custom stock statuses:

window.boostWidgetIntegration.extend('FilterHelper', (FilterHelper) => {
  return class CustomFilterHelper extends FilterHelper {
    protected convertValueRequestStockStatus(value) {
      if (Array.isArray(value)) {
        return value.map(v => {
          // Support custom 'low-stock' status
          if (v === 'out-of-stock' || v === 'low-stock') return false;
          return true;
        });
      }
      return value !== 'out-of-stock' && value !== 'low-stock';
    }
  };
});