# random-sentence

> Return a random sentence populated by semi-pronounceable random (nonsense) words.

Latest version **1.0.4** (published 2016-04-25) · MIT license · 0 weekly downloads

## Install

```sh
npm install random-sentence
pnpm add random-sentence
yarn add random-sentence
bun add random-sentence
```

## 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.4 |
| Published | 2016-04-25 |
| First published | 2016-04-11 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 4 |
| Author | bubkoo |
| Maintainers | bubkoo |
| Keywords | sentence, title, world, article, nonsense, random, randomly, randomize, chance, test, dice, mock |

## Links

- npm: https://www.npmjs.com/package/random-sentence
- Repository: https://github.com/mock-end/random-sentence
- Homepage: https://github.com/mock-end/random-sentence#readme
- Issues: https://github.com/mock-end/random-sentence/issues
- npm.io page: https://npm.io/package/random-sentence

## Dependencies (3)

- [clamp](https://npm.io/package/clamp.md) ^1.0.1
- [random-lorem](https://npm.io/package/random-lorem.md) ^1.0.4
- [random-natural](https://npm.io/package/random-natural.md) ^1.0.3

## Alternatives

- [duck](https://npm.io/package/duck.md) — 4.2M weekly downloads
- [ava](https://npm.io/package/ava.md) — 560.2K weekly downloads
- [storybook-addon-module-mock](https://npm.io/package/storybook-addon-module-mock.md) — 71.7K weekly downloads
- [@ethereum-waffle/mock-contract](https://npm.io/package/@ethereum-waffle/mock-contract.md) — 40.0K weekly downloads
- [aws-elasticsearch-connector](https://npm.io/package/aws-elasticsearch-connector.md) — 37.4K weekly downloads

## Recent versions

- 1.0.4 (latest) — 2016-04-25
- 1.0.3 — 2016-04-24
- 1.0.2 — 2016-04-24
- 1.0.1 — 2016-04-18
- 1.0.0 — 2016-04-18
- 0.0.0 — 2016-04-11

## README

# random-sentence

> Return a random sentence populated by semi-pronounceable random (nonsense) words.

[![MIT License](https://img.shields.io/badge/license-MIT_License-green.svg?style=flat-square)](https://github.com/mock-end/random-sentence/blob/master/LICENSE)

[![build:?](https://img.shields.io/travis/mock-end/random-sentence/master.svg?style=flat-square)](https://travis-ci.org/mock-end/random-sentence)
[![coverage:?](https://img.shields.io/coveralls/mock-end/random-sentence/master.svg?style=flat-square)](https://coveralls.io/github/mock-end/random-sentence)


## Install

```
$ npm install --save random-sentence
```

## Usage

> For more use-cases see the [tests](https://github.com/mock-end/random-sentence/blob/master/test/spec/index.js)

```js
var randomSentence = require('random-sentence');

// API
// - randomSentence([options]);

// options
// - words
// - min
// - max
```

The sentence starts with a capital letter, and ends with a period.

Default is a sentence with a random number of words from `12` to `18`.

*This length is chosen as the default as it works out to the average English sentence is in that range.*

```js
randomSentence();
// => 'Witpevze mappos isoletu fo res bi geow pofin mu rupoho revzi utva ne.'
```

Optionally specify the number of words in the sentence:

```js
randomSentence({words: 5});
// => 'Waddik jeasmov cakgilta ficub up.'
```

Can optionally provide `min` and `max`, then with a random words count:

```js
randomSentence({min: 4, max: 9});
// => 'Fusce dapibus tellus ac cursus commodo.'
```

**Note**: these min and max are **inclusive**, so they are included in the range. 


## Related

- [random-syllable](https://github.com/mock-end/random-syllable) - Return a semi-speakable syllable, 2 or 3 letters.
- [random-lorem](https://github.com/mock-end/random-lorem) - Return a semi-pronounceable random (nonsense) word.
- [random-title](https://github.com/mock-end/random-title) - Return a random title populated by semi-pronounceable random (nonsense) words.
- [random-paragraph](https://github.com/mock-end/random-paragraph) - Return a random paragraph generated from sentences populated by semi-pronounceable random (nonsense) words.


## Contributing

Pull requests and stars are highly welcome.

For bugs and feature requests, please [create an issue](https://github.com/mock-end/random-sentence/issues/new).

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