typing-ahead
v1.0.4
Published
A lightweight module for generating a data model to perform typeahead or autocomplete task in logarithmic time.
Downloads
27
Readme
A lightweight library to build data model for typeahead feature
typing-ahead
This is a lightweight module for generating a data model to perform typeahead or autocomplete task in logarithmic time.
It has two public methods:
- generate: Lets you generate a data model consists of words
- find: Finds the closest match of the input word within the provided model
Get Started
Import the module onto your project and build the data model by passing an array of words
Pass the model and some characters to the
find
function to get results
Example
const typingAhead = require('typing-ahead');
const myModel = typingAhead.generate(['typingahead', 'autocomplete']);
const results = typingAhead.find('typing', myModel); // result ['typingahead']
This example is made with Jam3 NextJS Generator
Unit Test
There are some test cases provided in ./__test__/index.test.js
to ensure that the data model is built correctly.
npm test