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

spellcheck-api

v0.1.7

Published

Simple spellcheck API

Downloads

10

Readme

Spellcheck API

HTTP spellcheck API based off hunspell.

The API server needs node version 0.11.0 or higher and to be ran with the --harmony flag.

Install

git clone [email protected]:montanaflynn/Spellcheck-API.git
npm install

Usage

node --harmony ./server.js [port]

Default port is 8080.

Example

node --harmony server 1337 &
curl "localhost:1337?text=wrng"
{
  "original": "wrng",
  "suggestion": "wrong",
  "corrections": {
    "wrng": [
      "wrong",
      "wing",
      "wring",
      "wrung"
    ]
  }
}

Responses

If there is no text querystring parameter return error message:

{"error":"Missing 'text' query parameter"}

If there are no mistakes return false for suggestion.

{
  "original": "the words are fine.",
  "suggestion": false
}

If there are mistakes but no suggestions return null for suggestion and corrections.

{
  "original": "dfdgdfg is gfdgdfsg.",
  "suggestion": null,
  "corrections": {
    "dfdgdfg": null,
    "gfdgdfsg": null
  }
}

If there are mistakes and suggestions return an array for each correction and replace the word in the suggestion string.

{
  "original": "thefdeee123 is theedffdfde is baddd.",
  "suggestion": "thefdeee123 is theedffdfde is bad.",
  "corrections": {
    "thefdeee123": null,
    "theedffdfde": null,
    "baddd": [
      "bad",
      "addd",
      "bddd",
      "badd"
    ]
  }
}

FAQ

Didn't this use to be a PHP project?

Yes indeed, however the PHP version is no longer supported. The source code is still available.

Contributing

Forks and pull requests are most welcomed.

License

The MIT License (MIT)

Copyright 2014, Montana Flynn (http://anonfunction.com/)