@lfaler/honeybee-spellcheck

## To Install ``` npm i -S @lfaler/spellcheck ```

Usage no npm install needed!

<script type="module">
  import lfalerHoneybeeSpellcheck from 'https://cdn.skypack.dev/@lfaler/honeybee-spellcheck';
</script>

README

Spellcheck CLI

To Install

npm i -S @lfaler/spellcheck

To test CLI

npm i -g @lfaler/spellcheck
spellcheck

Javascript Wrapper functions


const querySingleWord = (singleWord, percentage = 90, returnType = 'accurancy', amount = 1, followingLength = 3) => {
    axios.get(`https://honeybee-spellcheck.herokuapp.com/api/v1/single/spellcheck?term=${singleWord}&language=us-en&amount=${amount}&percentage=${percentage}&following_length=${followingLength}&return_type=${returnType}`)
        .then((response) => {
            callback(null, response.data);
        })
        .catch((error) => {
            callback(error, null);
        })
};

module.exports = { querySingleWord };

To Import and Use


const { querySingleWord } = require('@lfaler/honeybee-spellcheck');

querySingleWord(singleWord);

URL Queries


`https://honeybee-spellcheck.herokuapp.com/api/v1/single/spellcheck?term=${singleWord}&language=us-en&amount=${amount}&percentage=${percentage}&following_length=${followingLength}&return_type=${returnType}`

  • Accurancy % of given word matching (default: 90)
  • Amount of objects reutrned (default: 1)
  • Return Type want to return [Options: 'any', 'accurancy', 'following', 'others'] (default: accurancy)
  • Following Length how many characters check over the given string length (default: 3)