Skip to content
Grammarbot Javascript Client
JavaScript
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
lib Added fix for #1 Aug 22, 2019
test Added request helper test Dec 14, 2018
.eslintignore Added eslint support for linting Dec 14, 2018
.eslintrc.js Added eslint support for linting Dec 14, 2018
.gitignore Updated gitignore Dec 14, 2018
.npmignore Added npmrc and npmignore files Dec 14, 2018
.npmrc Added npmrc and npmignore files Dec 14, 2018
.travis.yml
LICENSE Added MIT License Dec 14, 2018
README.md Fixed case sensitive typo in badges Dec 14, 2018
index.js Added index.js entry Dec 14, 2018
package-lock.json Fixed vulnerabilities Aug 22, 2019
package.json Bumped version to publish package Aug 22, 2019

README.md

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': 'pro.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.

You can’t perform that action at this time.