# @gear4s/random-words

> Random word library

Latest version **0.0.2-1** (published 2021-03-01) · MIT license · 0 weekly downloads

## Install

```sh
npm install @gear4s/random-words
pnpm add @gear4s/random-words
yarn add @gear4s/random-words
bun add @gear4s/random-words
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.2-1 |
| Published | 2021-03-01 |
| First published | 2021-03-01 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 67.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | gear4s |

## Links

- npm: https://www.npmjs.com/package/@gear4s/random-words
- Repository: https://lab.aaronleem.co.za/personal-projects/random-words
- npm.io page: https://npm.io/package/@gear4s/random-words

## Recent versions

- 0.0.2-1 (latest) — 2021-03-01
- 0.0.2 — 2021-03-01
- 0.0.1 — 2021-03-01

## README

# Random Words!

Generate some random words, with a sane API

## How do I use it?

To generate a random-ass, normal word, you can just import and call this function:
```js
import GenerateRandomWord from "@gear4s/random-words";
const RandomWords = GenerateRandomWord();
```

You can also generate words that start with a letter:
```js
import GenerateRandomWord from "@gear4s/random-words";

const startingLetter = "a";
const RandomWords = GenerateRandomWord(startingLetter);
```

Or generate words with a maximum length:
```js
import GenerateRandomWord from "@gear4s/random-words";

const RandomWords = GenerateRandomWord(null, 6);
```

You can also generate more than one word at a time:
```js
import GenerateRandomWord from "@gear4s/random-words";

const RandomWords = GenerateRandomWord(null, null, 15);
```

## Argument list

- letter
  - type: string
  - default: null
- maxLength
  - type: number
  - min: 1
  - default: null
- count
  - type: number
  - min: 1
  - default: null

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