# language-grammar-api

> API wrapper for LanguageTool (grammar check) API based as plugin for Trembita.js

Latest version **1.1.6** (published 2019-03-11) · ISC license · 0 weekly downloads

## Install

```sh
npm install language-grammar-api
pnpm add language-grammar-api
yarn add language-grammar-api
bun add language-grammar-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.1.6 |
| Published | 2019-03-11 |
| First published | 2019-03-05 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=8.0.0 <11.0.0 |
| Dependencies | 1 |
| Unpacked size | 116.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Oleg Koval |
| Maintainers | olegkoval |
| Keywords | api wrapper, trembita plugin, grammar api, check grammar, grammar, api, grammar check, language tool |

## Links

- npm: https://www.npmjs.com/package/language-grammar-api
- Repository: https://github.com/oleg-koval/language-grammar-api
- Homepage: https://github.com/oleg-koval/language-grammar-api#readme
- Issues: https://github.com/oleg-koval/language-grammar-api/issues
- npm.io page: https://npm.io/package/language-grammar-api

## Dependencies (1)

- [trembita](https://npm.io/package/trembita.md) ^1.0.5

## Recent versions

- 1.1.6 (latest) — 2019-03-11
- 1.1.5 — 2019-03-11
- 1.1.4 — 2019-03-11
- 1.1.3 — 2019-03-11
- 0.0.0-development — 2019-03-05

## README

node.js grammar / language tool api
===================================

[![codecov](https://codecov.io/gh/oleg-koval/language-grammar-api/branch/master/graph/badge.svg)](https://codecov.io/gh/oleg-koval/language-grammar-api) [![CircleCI](https://circleci.com/gh/oleg-koval/language-grammar-api/tree/master.svg?style=svg)](https://circleci.com/gh/oleg-koval/language-grammar-api/tree/master)

# About

API wrapper for https://languagetool.org/ service (LanguageTool HTTP JSON API)

# Install

```sh
npm i -S language-grammar-api
```

# Usage

1. Create client
```js
const LanguageToolApi = require('language-grammar-api');

const options = {
  endpoint: 'https://languagetool.org/api/v2'
};

const languageToolClient = new LanguageToolApi(options);
```

2. Get list of supported languages:
```js
const languages = await languageToolClient.languages();
```

3. Check your text for specific language:
```js
const check = await languageToolClient.check({
  text: 'Amazing text to check', // required
  language: 'en-US' // required (you can use .languages call to get language)
});
```

More details about api: http://wiki.languagetool.org/public-http-api

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