# today-idiom

> A Node.js package that picks an English idiom for today

Latest version **1.0.2** (published 2020-09-16) · MIT license · 0 weekly downloads

## Install

```sh
npm install today-idiom
pnpm add today-idiom
yarn add today-idiom
bun add today-idiom
```

## 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.2 |
| Published | 2020-09-16 |
| First published | 2020-09-16 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 4.1 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Author | Tien-Dzung Nguyen |
| Maintainers | kutiekat |
| Keywords | package, npm, nodejs, idiom, english, today-idiom, idiom-of-the-day |

## Links

- npm: https://www.npmjs.com/package/today-idiom
- Repository: https://github.com/KutieKat/today-idiom
- Homepage: https://github.com/KutieKat/today-idiom#readme
- Issues: https://github.com/KutieKat/today-idiom/issues
- npm.io page: https://npm.io/package/today-idiom

## Dependencies (3)

- [cheerio](https://npm.io/package/cheerio.md) ^1.0.0-rc.3
- [request](https://npm.io/package/request.md) ^2.88.2
- [request-promise](https://npm.io/package/request-promise.md) ^4.2.6

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 1.0.2 (latest) — 2020-09-16

## README

# today-idiom

:pushpin: A Node.js package that picks an English idiom for today

## Table of Contents

- [Installation](#installation)
- [Methods](#methods)
- [Examples](#examples)
- [Author](#author)
- [License](#license)

## Installation

Using npm:

```bash
$ npm install today-idiom
```

Using yarn:

```bash
$ yarn add today-idiom
```

## Methods

### getIdiom()

## Examples

### Import the package

#### NodeJS

```js
const todayIdiom = require('today-idiom');
```

#### ES6/ TypeScript

```js
import todayIdiom from 'today-idiom';
```

### How to use

```js
(async () => {
  try {
    const idiom = await todayIdiom.getIdiom();

    console.log(idiom);
    /* {
      idiom: 'a war of words',
      meaning: "If you're in a war of words with someone, you're having a long argument or dispute with them.",
      examples: [
        'The leaders of the two main political parties are in a war of words over the issue of gun ownership. They debate the topic whenever they see each other.',
        'The war of words between community leaders and church leaders has been dominating the newspaper headlines lately.'
      ]
    } */
  } catch (error) {
    console.log(error);
  }
})();
```

## Author

[Tien-Dzung Nguyen (KutieKat)](https://github.com/KutieKat)

## License

[MIT](LICENSE)

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