methods/set-product-ids.js

  1. import commonFilter from './../lib/common-filter'
  3. // handle filter by product IDs
  4. export default (self, productIds) => commonFilter(self, null, '_id', productIds)
  6. /**
  7.  * @method
  8.  * @name EcomSearch#setProductIds
  9.  * @description Defines list of product IDs to match on next search request.
  10.  *
  11.  * @param {array<string>|null} productIds - List of product ObjectIDs (`_id`)
  12.  * @returns {self}
  13.  *
  14.  * @example
  16. // Set filter by ID and run search request
  17. search.setProductIds([ '5c703c40c626be23430d5033' ]).fetch()
  19.  * @example
  21. // Remove filter by product ID
  22. search.setProductIds(null)
  24.  */