npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

languagetool-api

v1.1.2

Published

Node.JS wrapper for LanguageTool HTTP JSON API

Downloads

148

Readme

LanguageTool is the best choice, for your grammar/spell checking apps, check it out here.

INSTALLATION:

$ npm install languagetool-api

After you install package, make sure to require it in your application!

const languagetool = require("languagetool-api");

USAGE:

languagetool.check() takes 2 arguments:

  1. Object with request parameters (for more details see: check() object params)
  2. Callback function

Here's an example:

const languagetool = require("languagetool-api");

var params = {
  language: "pl-PL", // This is required! You can get list of language codes with languagetool.codes
  text: "Piekasz", // This is required too!
};

languagetool.check(params, function(err, res){
	if(err){
	   console.log(err);
	} else{
	   console.log(res);
	}
});

res can be used with other functions provided by wrapper. These functions are listed below check() object params section.

check() object params

As you know, check() function needs object with parameters. They're listed and compared below:

| Name | Required? | Type |Description |Example | |-------------------|-------------------|-----------|------------------------------------------------|-------------------------| |language |yes | string |Code of language |"pl-PL" | |text |yes | string |Text to check |"Piekarz" | |disabledRules |no | array |Array of rule IDs |["MORFOLOGIK_RULE_PL_PL"]| |enabledRules |no | array |Array of rule IDs |["MORFOLOGIK_RULE_PL_PL"]| |enabledCategories |no | array |Array of category IDs |["TYPOS"] | |disabledCategories |no | array |Array of category IDs |["TYPOS"] | |preferredVariants |no | array |Array of language codes |["en-GB", "de-AT"] | |enabledOnly |no | boolean |If true, only enabledCategories array is checked|false |

languagetool.showMistakes(res, callback)

languagetool.showMistakes should take res from langaugetool.check and give you access to array of mistakes (as strings).

Here's an example:

languagetool.check(params, function(err, res){
	if(err){
	   console.log(err);
	} else{
	   languagetool.showMistakes(res, function(arr){
	     arr.forEach(function(item){
	       console.log(item);
	     });
	   });
	};
});

languagetool.bestSuggestion(res, callback)

This function should also take res from languagetool.check, and give you access to array of objects with properties: mistake (string), and bestSuggestion (also string).

Here's an example:

languagetool.check(params, function(err, res){
	if(err){
	   console.log(err);
	} else{
	   languagetool.bestSuggestion(res, function(arr){
	     arr.forEach(function(item){
	       console.log("Best suggestion for " + item.mistake + " is " + item.bestSuggestion);
	     });
	   });
	};
});

NOTE: This wrapper utilizes other packages, that are required for languagetool-api to work properly. Github repository doesn't provide them, but package on npmjs.com does. If you got this package from Github, make sure to install them. Packages are listed in package.json file (see: "dependencies").