1.0.0 • Published 8 years ago
hubspell-speller v1.0.0
hubspell-speller
HubSpell spell checker.
Installation
Install hubspell-speller
by running:
$ npm install --save hubspell-speller
Documentation
speller.getSuggestions(text, options, callback)
Kind: static method of speller
Summary: Get suggestions for incorrect words from a text
Access: public
Param | Type | Description |
---|---|---|
text | String | text |
options | Object | options |
options.language | String | language |
options.ignore | Array.<String> | Array.<RegExp> | ignore patterns |
callback | function | callback (error, suggestions) |
Example
speller.getSuggestions('Hello Worl', {
language: 'en_US'
}, function(error, suggestions) {
if (error) throw error;
console.log(suggestions.Worl);
});
Support
If you're having any problem, please raise an issue on GitHub and the HubSpell team will be happy to help.
Tests
Run the test suite by doing:
$ gulp test
Contribute
- Issue Tracker: github.com/hubspell/hubspell-speller/issues
- Source Code: github.com/hubspell/hubspell-speller
Before submitting a PR, please make sure that you include tests, and that jshint runs without any warning:
$ gulp lint
License
The project is licensed under the MIT license.
1.0.0
8 years ago