Nodeasaur

Nodeasaur is a simple node.js client for the Big Huge Words thesaurus API. Find more info here on the API and obtaining a key. The distinction between this package and similar Node clients is the separation of the target word from the JS code. Rather than hardcoding the target word into any .js file, the looks inside a separate JSON file. This means in theory the code could act as a middleman between a JSON-generating code (e.g A Twilio client) and the BHL API.

Basics

The client looks for two JSON files to operate:

  • key.JSON -- Your API Key
  • Word.JSON --The word you are seeking a synonym(s) for

Usage

Nodeasaur is a standard node-based JS program run using

npm main.js

API Key

Once you have applied for and been granted an API key, edit key.JSON accordingly.

{ "apiKey": "Your key here"} 

Input file

The word.JSON file is similarly formattedf or you to put the original word in.

{ "word": "guitar"}

Output

The code gives a simple JSON packet with one or more synonyms (verb and noun), per the API docs.

{ noun: { syn: [ 'stringed instrument' ] } }

Contributing

Gladly accepting contributions

License

MIT

Built With

Share this project:

Updates