1 | # meant ![Build status](https://github.com/watilde/meant/workflows/Node.js%20CI/badge.svg)
|
2 |
|
3 | Like the `Did you mean?` in git for npm
|
4 |
|
5 | ## API
|
6 | ### meant(item, list)
|
7 | + item {String} A key for finding an approximate value
|
8 | + list {Array} A list for comparing with the item
|
9 |
|
10 | ```js
|
11 | const meant = require('meant')
|
12 | const result = meant('foa', ['foo', 'bar', 'baz'])
|
13 | // => [ 'foo' ]
|
14 | ```
|
15 |
|
16 | ## Installation
|
17 |
|
18 | Download node at [nodejs.org](http://nodejs.org) and install it, if you haven't already.
|
19 |
|
20 | ```sh
|
21 | npm install meant --save
|
22 | ```
|
23 |
|
24 |
|
25 | ## Tests
|
26 |
|
27 | ```sh
|
28 | npm install
|
29 | npm test
|
30 | ```
|
31 | ```
|
32 |
|
33 | > meant@1.0.0 test /Users/watilde/Development/meant
|
34 | > standard && tap test.js
|
35 | TAP version 13
|
36 | # Subtest: test.js
|
37 | # Subtest: test vs ['tast', 'tbst', 'tcst', 'foo']
|
38 | ok 1 - list has tast
|
39 | ok 2 - list has tbst
|
40 | ok 3 - list has tcst
|
41 | ok 4 - list doesn't have foo
|
42 | 1..4
|
43 | ok 1 - test vs ['tast', 'tbst', 'tcst', 'foo'] # time=11.816ms
|
44 | 1..1
|
45 | # time=44.006ms
|
46 | ok 1 - test.js # time=249.154ms
|
47 | 1..1
|
48 | # time=267.371ms
|
49 |
|
50 | ```
|
51 |
|
52 | ## Dependencies
|
53 |
|
54 | None
|
55 |
|
56 | ## Dev Dependencies
|
57 |
|
58 | - [standard](https://github.com/feross/standard): JavaScript Standard Style
|
59 | - [standard-version](https://github.com/conventional-changelog/standard-version): replacement for `npm version` with automatic CHANGELOG generation
|
60 | - [tap](https://github.com/tapjs/node-tap): A Test-Anything-Protocol library
|
61 |
|
62 |
|
63 | ## License
|
64 |
|
65 | MIT
|
66 |
|
67 | _Generated by [package-json-to-readme](https://github.com/zeke/package-json-to-readme)_
|