# datamuse

> node module for the Datamuse API v1

Latest version **1.0.5** (published 2016-08-13) · MIT license · 0 weekly downloads

## Install

```sh
npm install datamuse
pnpm add datamuse
yarn add datamuse
bun add datamuse
```

## 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.0.5 |
| Published | 2016-08-13 |
| First published | 2016-03-08 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=4 |
| Dependencies | 1 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 40 |
| Author | Andre Stehle |
| Maintainers | ansteh |
| Keywords | datamuse api, datamuse, wrapper, api, promise |

## Links

- npm: https://www.npmjs.com/package/datamuse
- Repository: https://github.com/ansteh/datamuse
- Homepage: https://github.com/ansteh/datamuse#readme
- Issues: https://github.com/ansteh/datamuse/issues
- npm.io page: https://npm.io/package/datamuse

## Dependencies (1)

- [got](https://npm.io/package/got.md) ^6.3.0

## Alternatives

- [@commercetools/sync-actions](https://npm.io/package/@commercetools/sync-actions.md) — 25.1K weekly downloads
- [cwait](https://npm.io/package/cwait.md) — 21.4K weekly downloads
- [@ledgerhq/hw-app-cosmos](https://npm.io/package/@ledgerhq/hw-app-cosmos.md) — 4.2K weekly downloads
- [@financial-times/o-loading](https://npm.io/package/@financial-times/o-loading.md) — 2.8K weekly downloads
- [fa](https://npm.io/package/fa.md) — 185 weekly downloads

## Recent versions

- 1.0.5 (latest) — 2016-08-13
- 1.0.4 — 2016-05-02
- 1.0.3 — 2016-04-08
- 1.0.2 — 2016-04-08
- 1.0.1 — 2016-04-08
- 1.0.0 — 2016-04-08
- 0.0.7 — 2016-03-09
- 0.0.6 — 2016-03-09
- 0.0.5 — 2016-03-09
- 0.0.4 — 2016-03-08
- 0.0.3 — 2016-03-08
- 0.0.2 — 2016-03-08
- 0.0.1 — 2016-03-08

## README

[![Build Status](https://api.travis-ci.org/ansteh/datamuse.svg?branch=master)](https://travis-ci.org/ansteh/datamuse)

## Install

Using npm:

```js
npm install datamuse
```

The Datamuse API is a word-finding query engine for developers.
The official website illustrates the kinds of queries you can make: [Datamuse API](http://www.datamuse.com/api/).
This module helps you to make queries and supports promises.

## Usage

Straight forward approach by providing a query.
```js
const datamuse = require('datamuse');

datamuse.request('words?ml=ringing in the ears')
.then((json) => {
  console.log(json);
  //do it!
});

```

Use words as shortcut.
```js
datamuse.words({
  ml: 'ringing in the ears'
})
.then((json) => {
  console.log(json);
  //do it!
});
```

Use sug as shortcut.
```js
datamuse.sug({
  s: 'rawand'
})
.then((json) => {
  console.log(json);
  //do it!
});
```

## License

MIT © [Andre Stehle](https://github.com/ansteh)

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