Skip to content
master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
lib
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Build Status Coverage Status Downloads Try on RunKit

Grammarbot

A Javascript API client Grammarbot.io

Documentation

Take a look at the official docs at grammarbot.io/quickstart

Installation

$ npm install grammarbot

Methods

1. grammarbot.check(text, callback)

2. grammarbot.checkAsync(text)

Usage

const Grammarbot = require('grammarbot');

const bot = new Grammarbot({
  'api_key' : 'YOUR_API_KEY',      // (Optional) defaults to node_default
  'language': 'LANG_CODE',         // (Optional) defaults to en-US
  'base_uri': 'api.grammarbot.io', // (Optional) defaults to api.grammarbot.io
});

// Callback style
bot.check("I can't remember how to go their", function(error, result) {
  if (!error) console.log(JSON.stringify(result));
});

// Async/Await style
const result = await bot.checkAsync("I can't remember how to go their");
console.log(JSON.stringify(result));

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/Ayoubelk/grammarbot

License

This npm package is available under the terms of the MIT License.

About

Grammarbot Javascript Client

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published