# custom-grammar-bot-api

> Customer GrammerBot API.

Latest version **1.0.3** (published 2019-10-14) · ISC license · 0 weekly downloads

## Install

```sh
npm install custom-grammar-bot-api
pnpm add custom-grammar-bot-api
yarn add custom-grammar-bot-api
bun add custom-grammar-bot-api
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.3 |
| Published | 2019-10-14 |
| First published | 2019-10-14 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 5.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Chandrakant Devani |
| Maintainers | chandrakantdevani |

## Links

- npm: https://www.npmjs.com/package/custom-grammar-bot-api
- npm.io page: https://npm.io/package/custom-grammar-bot-api

## Recent versions

- 1.0.3 (latest) — 2019-10-14
- 1.0.1 — 2019-10-14
- 1.0.0 — 2019-10-14

## README

[![](https://img.shields.io/npm/v/grammarbot.svg)](https://www.npmjs.com/package/grammarbot)
[![Build Status](https://travis-ci.org/AyoubElk/grammarbot.svg?branch=master)](https://travis-ci.org/AyoubElk/grammarbot)
[![Coverage Status](https://coveralls.io/repos/github/AyoubElk/grammarbot/badge.svg)](https://coveralls.io/github/AyoubElk/grammarbot)
[![Downloads](https://img.shields.io/npm/dm/grammarbot.svg)](https://www.npmjs.com/package/grammarbot)
[![Try on RunKit](https://badge.runkitcdn.com/grammarbot.svg)](https://runkit.com/npm/grammarbot)

# Grammarbot

A Javascript API client Grammarbot.io

I have some change in Grammarbot Client function.


## Documentation

Take a look at the official docs at [grammarbot.io/quickstart](https://www.grammarbot.io/quickstart)


## Installation

```bash
$ npm install custom-grammar-bot-api --save
```


## Methods

### 1. grammarbot.check(text, callback)
### 2. grammarbot.checkAsync(text)


## Usage

```js
const Grammarbot = require('custom-grammar-bot-api');

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](http://opensource.org/licenses/MIT).

---
_Source: https://npm.io/package/custom-grammar-bot-api · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._