Overview

Installation

Can be managed using yarn, npm, or jspm.

yarn

yarn add @aureooms/js-search

npm

npm install @aureooms/js-search --save

jspm

jspm install npm:@aureooms/js-search

Usage

:warning: The code needs a ES2015+ polyfill to run (regeneratorRuntime), for instance regenerator-runtime/runtime.

First, require the polyfill at the entry point of your application

require( 'regenerator-runtime/runtime' ) ;
// or
import 'regenerator-runtime/runtime' ;

Then, import the library where needed

const search = require( '@aureooms/js-search' ) ;
// or
import * as search from '@aureooms/js-search' ;

Examples

More examples in the test files.