werd
v0.2.7
Published
Words API for JavaScript
Downloads
83
Maintainers
Readme
werd
Words API for JavaScript
Made with ❤ at @outlandish
An unofficial Words API library for JavaScript with a CLI.
See wordsapi.com for details on the Words API, "an API for the English language".
Install
API
npm install --save werd
CLI
npm install --global werd
Requirements
- Mashape Words API key (get one here)
- Node >= v4 for CLI
Import
// ES6
import werd from 'werd'
// CommonJS
var werd = require('werd')
<!-- Script, available at `window.werd` -->
<script src="/node_modules/werd/dist/werd.min.js"></script>
API
Read the Words API documentation for more details:
https://market.mashape.com/wordsapi/wordsapi
werd(word) : Promise<Object>
Get a word definition object. Also available as werd.get()
.
- word {String} The word
Returns a Promise that resolves to the word definition object.
werd.{operation}(word) : Promise<Object>
Get data for the given word respective to the chosen operation.
- word {String} The word
Returns a Promise that resolves with the respective data.
Available operations:
definitions, synonyms, antonyms, examples, typeOf, hasTypes,
partOf, instanceOf, hasInstances, similarTo, also, syllables,
entails, memberOf, hasMembers, substanceOf, hasSubstances,
inCategory, hasCategories, usageOf, hasUsages, inRegion,
regionOf, pertainsTo, rhymes, frequency, pronunciation, hasParts
CLI Usage
You will be prompted for your Mashape API key the first time you use the CLI.
$ werd|word --help
Usage
$ werd|word <word> [<operation>]
Inputs
word, the word to query
operation, the query operation (default: get)
Examples
$ word chump
$ werd program synonyms
$ werd ocean syllables
Contributing
All pull requests and issues welcome!
If you're not sure how, check out Kent C. Dodds' great video tutorials on egghead.io!
Author & License
werd
was created by Sam Gluck and is released under the MIT license.