Product Search Library

A JavaScript library for product search functionality, designed to help with filtering and finding products in e-commerce applications.

Installation

npm install product-search-lib

Usage

const productSearch = require('product-search-lib');

// Search for products
const searchResults = productSearch.search('laptop', { 
  limit: 5, 
  caseSensitive: false 
});
console.log(searchResults);

// Get a product by ID
const product = productSearch.getProductById(123);
console.log(product);

// Filter products by criteria
const filteredProducts = productSearch.filterProducts({
  category: 'Electronics',
  minPrice: 500,
  maxPrice: 1500
});
console.log(filteredProducts);

API

search(query, options)

Search for products based on a text query.

• query (string): The search term
• options (object): Optional configuration
  • limit (number): Maximum number of results (default: 10)
  • caseSensitive (boolean): Whether search should be case sensitive (default: false)

Returns an array of matching products.

getProductById(id)

Get product details by ID.

• id (number): The product ID

Returns a product object or null if not found.

filterProducts(criteria)

Filter products based on specified criteria.

• criteria (object): Filter parameters
  • category (string): Product category
  • minPrice (number): Minimum price
  • maxPrice (number): Maximum price

Returns an array of filtered products.

License

MIT