npm install hubspell-spellerhubspell-speller
----------------
HubSpell spell checker.
Installation
------------
Install hubspell-speller by running:
``sh`
$ npm install --save hubspell-speller
Documentation
-------------
speller | 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
`js
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:
`sh`
$ 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:
`sh``
$ gulp lint
License
-------
The project is licensed under the MIT license.