# scrab

> A random word and sentence generation library.

Latest version **1.1.0** (published 2017-11-19) · MIT license · 0 weekly downloads

## Install

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

## 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.1.0 |
| Published | 2017-11-19 |
| First published | 2014-07-07 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 (+5 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Jackson Ray Hamilton |
| Maintainers | jacksonrayhamilton |

## Links

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

## Dependencies (2)

- [lodash](https://npm.io/package/lodash.md) ^2.4.1
- [wordlist-english](https://npm.io/package/wordlist-english.md) ^1.2.0

## Recent versions

- 1.1.0 (latest) — 2017-11-19
- 1.0.0 — 2017-07-23
- 0.0.7 — 2014-07-15
- 0.0.6 — 2014-07-08
- 0.0.5 — 2014-07-08
- 0.0.4 — 2014-07-07
- 0.0.3 — 2014-07-07
- 0.0.2 — 2014-07-07
- 0.0.1 — 2014-07-07

## README

# scrab

A random word and sentence generation utility.

Usage:

```bash
npm install --save scrab
```

```javascript
var scrab = require('scrab');

console.log('My favorite word of all time is "' + scrab.word() + '".');
// => My favorite word of all time is "interpretation".

scrab.word({
    preposition: true
});
// => "off"
// => "down"

scrab.word({
    conjunction: true
});
// => "so"
// => "and"

// Capitalize the first letter of random words.
scrab.word({
    capitalize: true
});
// => "Contact"

// Get a bunch of random words.
scrab.words();
// => ["secret", "senility", "bedside", "corrupting", "was", "indicates"]

// Get totally random sentences.
scrab.sentence();
// => "Significance including budget; creates because where?"
// => "Bed perform justify emergency!""
// => "Lay: his; matter after while until.""

// Get sentences with specific criteria.
scrab.sentence({
    min: 2,
    max: 3,
    capitalize: true,
    punctuate: false
});
// => "Incline Supposedly Books"

// SCREAM!!!
scrab.sentence({
    scream: true
});
// => GRANTED DRUNKS; THEMSELVES DISCUSSES!!!
// => REPRODUCE LIMITED PROGRESSIVE SAVES, CONCRETE DOPING!!!
```

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