# word-salad

> Human-centric unique identifiers

Latest version **0.0.1** (published 2017-03-25) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install word-salad
pnpm add word-salad
yarn add word-salad
bun add word-salad
```

Provides the command `mkWordSalad`.

## 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.1 |
| Published | 2017-03-25 |
| First published | 2017-03-25 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 5.12.0 |
| Dependencies | 3 |
| Known vulnerabilities | 0 (+2 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Ewan Dennis |
| Maintainers | ewandennis |
| Keywords | locator, identifier, id, uuid, human |

## Links

- npm: https://www.npmjs.com/package/word-salad
- Repository: https://github.com/ewandennis/word-salad
- Homepage: https://github.com/ewandennis/word-salad#readme
- Issues: https://github.com/ewandennis/word-salad/issues
- npm.io page: https://npm.io/package/word-salad

## Dependencies (3)

- [q](https://npm.io/package/q.md) ^1.4.1
- [bignum](https://npm.io/package/bignum.md) ^0.12.5
- [istanbul](https://npm.io/package/istanbul.md) ^0.4.5

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 0.0.1 (latest) — 2017-03-25

## README

# Word Salad

Human-centric unique identifers for use in place of numeric record locators, account IDs and so on.

# Installation
Install Word Salad module from NPM:
```bash
npm install word-salad --save
```

# Exploration
Output a random identifier:

```bash
mkWordSalad
```
That will return something like "jet typist" or "indefinable sugarloaf".

To do that programmatically:

```javascript
console.log(require('word-salad').mkID());
```

# Map From Existing Numeric Identifiers
```javascript
const wordSalad = require('word-salad');
const person = {id:101, name:'Sue'}
person.id = wordSalad.fromInt(person.id);
```

# Map To Numeric Identifiers
```javascript
const wordSalad = require('word-salad');
const person = {id:'inimical pizzicato', name:'Sue'}
person.id = wordSalad.toInt(person.id);
```

# Generate A Sequence of Identifiers

```javascript
const wordSalad = require('word-salad');
for(let i = 0; i < 100; ++i) {
  console.log(wordSalad.nextID());
}
```

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