Skip to content

Latest commit

 

History

History
28 lines (20 loc) · 797 Bytes

README.md

File metadata and controls

28 lines (20 loc) · 797 Bytes

simple-text-search

Greenkeeper badge

Usage

  var filter = require('simple-text-search')
  var get = filter(['foo', 'bar', 'foobar'])
  var results = get('foo')
  // -> returns ['foo', 'foobar']

Objects in a collection get stringified. So all properties get filtered. You can also define a property to filter in:

  var cities = [{id: 1, name: 'Zürich'}, {id: 2, name: 'Reykjavík'}]
  var get = filter(cities, 'name')
  var results = get('zurich')
  // -> returns [{id: 1, name: 'Zürich'}]

This module doesn't do any stemming except replacing umlauts.

Alternatives

Please use sifter if you need sorting or scoring.