1.0.0 • Published 6 years ago

@lfaler/honeybee-spellcheck v1.0.0

Weekly downloads
-
License
BSD-3
Repository
-
Last release
6 years ago

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)