checkr-drawish

0.0.3 • Public • Published

checkr-drawish

Check the users answer using the Levenshtein algorithm.

Codeship Status for bukinoshita/checkr-drawish npm GitHub release GitHub license

Install

$ npm install --save checkrDrawish

Usage

const checkrDrawish = require('checkr-drawish')
const rndDrawish = require('rnd-drawish')
 
checkrDrawish('userInput', rndDrawish.all).then(answer => {
  console.log(answer)
  //=> 'Answer'
  //=> 'Input', did you mean 'Answer'?
  //=> 'Input' not found
})

API

checkrDrawish(input, list)

input

Type: string
Required

list

Type: array
Required

Check users answer on the list

Related

  • drawish - ✏️ An awesome drawish game
  • rnd-drawish - 🔀 Random word generator for drawish

Understand Levenshtein Distance

Levenshtein distance is a string metric for measuring the difference between two sequences. Informally, the Levenshtein distance between two words is the minimum number of single-character edits (i.e. insertions, deletions or substitutions) required to change one word into the other.

A P P L E
0 1 2 3 4 5
P 1 1 1 2 3 4
I 2 2 2 2 3 4
N 3 3 3 3 3 4
E 4 4 4 4 4 3
A 5 4 5 5 5 4
P 6 5 4 5 6 5
P 7 6 5 4 5 6
L 8 7 6 5 4 5
E 9 8 7 6 5 4

The distance between the APPLE and PINEAPPLE is 4, that means that we have to edit the PINEAPPLE string 4 times.

  • Remove P.
  • Remove I.
  • Remove N.
  • Remove E.

License

MIT © Bu Kinoshita

Readme

Keywords

none

Package Sidebar

Install

npm i checkr-drawish

Weekly Downloads

1

Version

0.0.3

License

MIT

Last publish

Collaborators

  • bukinoshita