Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

fulfil

rafaelrinaldi39MIT1.0.0

Simple search suggestion using the Levenshtein distance algorithm.

fulfil, search, suggestion, spelling, grammar, typo, fix

readme

fulfil Build Status

Simple search suggestion using the Levenshtein distance algorithm.

Install

$ npm install fulfil --save

Usage

var words = require('superb').words;
var fulfil = require('fulfil');

fulfil('batueiful', words).shift(); // beautiful

API

fulfil(input, [suggestions])

Return: array

An array of suggestions sorted by the closest matches found.

keyword

Required
Type: string

Word used to lookup for a suggestion.

suggestions

Type: array

List of suggestions available.

License

MIT © Rafael Rinaldi

changelog

v1.0.0 (2015/08/17)

  • Initial release.