# sentence-builder

> Build a sentence with variability

Latest version **1.0.0** (published 2017-08-31) · ISC license · 0 weekly downloads

## Install

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

## 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.0 |
| Published | 2017-08-31 |
| First published | 2017-08-31 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | John Callahan |
| Maintainers | johnwcallahan |
| Keywords | cartesian, product, ai, voice, interface, sentence, builder, construct, language |

## Links

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

## Alternatives

- [@expo/fingerprint](https://npm.io/package/@expo/fingerprint.md) — 6.2M weekly downloads
- [@azure/monitor-opentelemetry-exporter](https://npm.io/package/@azure/monitor-opentelemetry-exporter.md) — 850.0K weekly downloads
- [@azure/monitor-opentelemetry](https://npm.io/package/@azure/monitor-opentelemetry.md) — 624.0K weekly downloads
- [@posthog/ai](https://npm.io/package/@posthog/ai.md) — 423.3K weekly downloads
- [fakefilter](https://npm.io/package/fakefilter.md) — 63.9K weekly downloads

## Recent versions

- 1.0.0 (latest) — 2017-08-31

## README

## Sentence Builder

Build a sentence with variability

```javascript
let sentence = [
  ['Hello', 'Hi'],
  ['World!', 'Earth!']
];

sentenceBuilder.build(sentence);
// Hi World!

sentenceBuilder.combos(sentence);
// ['Hello World!', 'Hi World!', 'Hello Earth!', 'Hi Earth!']
```

## Installation
1. Install the package: 
```
npm install --save sentence-builder
```

2. Require it in your project: 
```javascript
const sentenceBuilder = require('sentence-builder');
```

## Usage

### build()
Build a sentence:
```javascript
let sentence = [
  ['Hello', 'Hi'],
  ['World!', 'Earth!']
];

sentenceBuilder.build(sentence);
// Hi World!
```

All methods take a second parameter, `exclude`, which can be given as a single string or an array of strings.
```javascript
sentenceBuilder.build(sentence, 'Hi World!');
// Hi Earth!
```

Pass `true` as a third parameter to get output as an array.
```javascript
sentenceBuilder.build(sentence, null, true);
// ['Hi', 'World!']
```

### combos()
Effectively returns the Cartesian product.
```javascript
sentenceBuilder.combos(sentence);
// ['Hello World!', 'Hi World!', 'Hello Earth!', 'Hi Earth!']
```

Also takes the `exclude` parameter.
```javascript
sentenceBuilder.combos(sentence, ['Hi World!', 'Hello Earth!']);
// ['Hello World!', 'Hi Earth!']
```

Takes a third parameter, `limit`, which limits the results.
```javascript
sentenceBuilder.combos(sentence, null, 3);
// ['Hello World!', 'Hi World!', 'Hello Earth!']
```

### numCombos()
Returns the number of possible combinations.
```javascript
sentenceBuilder.numCombos(sentence);
// 4

sentenceBuilder.numCombos(sentence, 'Hi World!');
// 3
```

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