# blurbinator

> Generate placeholder text that looks like this:

Latest version **1.0.1** (published 2021-03-03) · ISC license · 0 weekly downloads

## Install

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

## Health

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

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2021-03-03 |
| First published | 2021-03-03 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 13 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | nmcapule |

## Links

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

## Dependencies (1)

- [typescript](https://npm.io/package/typescript.md) ^4.2.2

## Recent versions

- 1.0.1 (latest) — 2021-03-03
- 1.0.0 — 2021-03-03

## README

# Blurbinator

Generate placeholder text that looks like this:

```
▇▇ ▇▇▇ ▇▇▇ ▇▇ ▇▇. ▇▇▇ ▇▇▇▇ ▇▇▇▇▇ ▇▇▇▇▇ ▇▇▇▇▇ ▇▇ ▇▇▇▇ ▇ ▇. ▇▇▇ ▇▇▇▇▇ ▇ ▇▇▇▇▇ ▇▇▇▇ ▇▇▇▇ ▇. ▇ ▇▇ ▇▇▇▇ ▇▇▇ ▇▇▇▇▇ ▇▇▇▇ ▇▇▇▇▇ ▇▇▇▇▇ ▇▇▇▇ ▇▇▇ ▇▇ ▇▇▇▇▇ ▇▇▇ ▇. ▇▇▇ ▇▇▇ ▇ ▇▇▇▇▇ ▇ ▇▇▇▇ ▇▇ ▇▇ ▇▇▇▇ ▇▇▇▇▇ ▇▇ ▇▇▇▇ ▇▇▇▇▇. ▇▇ ▇▇▇▇▇ ▇▇▇▇ ▇▇▇ ▇▇▇▇▇ ▇ ▇▇▇▇ ▇▇▇ ▇▇▇ ▇ ▇▇▇▇.

▇▇▇▇▇ ▇▇▇ ▇▇▇▇ ▇▇▇ ▇▇▇▇▇. ▇▇ ▇▇▇▇ ▇ ▇▇ ▇▇▇▇▇ ▇▇▇ ▇▇▇. ▇▇▇▇▇ ▇▇▇▇ ▇ ▇▇▇ ▇▇ ▇▇ ▇▇▇▇▇. ▇▇▇▇ ▇▇▇ ▇▇ ▇▇▇ ▇▇ ▇▇▇.
```

It's pretty cute.

## Quick Start

1. **Install**

   ```sh
   npm install blurbinator
   ```

2. **Usage**

   ```ts
   import { blurb, BlurbOptions } from "blurbinator";

   const options: BlurbOptions = { stubChar: "a" };
   blurb(options); // e.g. Generated: aaa aa aaaa a aa.
   ```

## Quick Guide

```ts
export interface BlurbOptions<T> {
  /** RNG that outputs [0-1) */
  random?: () => number;
  /** Number of paragraphs to generate. */
  paragraphs?: [number, number];
  /** If set, preprocess the outputted paragraph array. */
  paragraphsConcat?: (arr: string[]) => T;
  /** Number of sentences per paragraph. */
  sentences?: [number, number];
  /** Number of words per sentence. */
  words?: [number, number];
  /** Number of characters in a word. */
  wordLen?: [number, number];
  /** Placeholder character. */
  stubChar?: string;
}
```

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