# @codenamize/codenamize

> Generate consistent easier-to-remember codenames from strings, numbers, or other seed inputs.

Latest version **1.1.1** (published 2018-10-31) · MIT license · 0 weekly downloads

## Install

```sh
npm install @codenamize/codenamize
pnpm add @codenamize/codenamize
yarn add @codenamize/codenamize
bun add @codenamize/codenamize
```

## 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.1 |
| Published | 2018-10-31 |
| First published | 2018-10-31 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 39.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 20 |
| Maintainers | stemail23 |
| Keywords | alias, aliases, anonymise, anonymize, code, codename, codenamise, codenamize, generator, secret |

## Links

- npm: https://www.npmjs.com/package/@codenamize/codenamize
- Repository: https://github.com/stemail23/codenamize-js
- npm.io page: https://npm.io/package/@codenamize/codenamize

## Dependencies (2)

- [underscore](https://npm.io/package/underscore.md) ^1.9.1
- [big-integer](https://npm.io/package/big-integer.md) ^1.6.36

## Alternatives

- [flatbuffers](https://npm.io/package/flatbuffers.md) — 6.0M weekly downloads
- [jwt-simple](https://npm.io/package/jwt-simple.md) — 259.5K weekly downloads
- [@exodus/patch-broken-hermes-typed-arrays](https://npm.io/package/@exodus/patch-broken-hermes-typed-arrays.md) — 28.5K weekly downloads
- [@native-to-anchor/buffer-layout](https://npm.io/package/@native-to-anchor/buffer-layout.md) — 12.2K weekly downloads
- [binary-parser-encoder](https://npm.io/package/binary-parser-encoder.md) — 5.3K weekly downloads

## Recent versions

- 1.1.1 (latest) — 2018-10-31

## README

# Codenamize

**Generate consistent easier-to-remember codenames from strings, numbers, or other seed inputs.**

# Overview

**Codenamize** is a JavaScript library for generating deterministic, alternative codenames for a given seed input. Using codenames in place of awkward identifiers, such as UUIDs, hashes, network addresses etc, helps human users to recall and quickly identify strings.

This is a JavaScript port of the original Python [codenamize](https://github.com/jjmontesl/codenamize) library, with extra extended capability!

# Installation

Install from the [npm repository](https://www.npmjs.com/package/@codenamize/codenamize).

With [yarn](https://yarnpkg.com)…

```shell
$ yarn add @codenamize/codenamize
```

… or with [npm](https://www.npmjs.com).

```shell
$ npm install @codenamize/codenamize
```

# Usage

## Importing

```javascript
const codenamize = require('@codenamize/codenamize');
```

## Generating codenames

### seed value

Output is deterministically based on the input seed. Numbers are converted to the equivalent string value.

The codenamize argument can be either a simple string or integer argument…

```javascript
codenamize(1);
// 'familiar-grand'

codenamize('1');
// 'familiar-grand'

codenamize('11:22:33:44:55:66');
// 'craven-delivery'
```

… or an `options` object argument.

```javascript
codenamize({ seed: '1' });
// 'familiar-grand'

codenamize({ seed: '11:22:33:44:55:66' });
// 'craven-delivery'
```

### classic mode

Classic mode uses `options.adjectiveCount` to determine the composition of the codename output, which will be made up of the specified number of adjectives, followed by a noun. Note that prepending more adjectives retains the existing codename words.

```javascript
codenamize({ seed: '11:22:33:44:55:66', adjectiveCount: 2 });
// 'separate-craven-delivery'

codenamize({ seed: '11:22:33:44:55:66', adjectiveCount: 3 });
// 'unsuitable-separate-craven-delivery'
```

### particles mode

Instead of `options.adjectiveCount`, the `options.particles` argument can alternatively be used to specify a more precise composition for the produced codename. The argument is an array of word categories which will be appended together to produce the output codename.

```javascript
> codenamize({ seed: '11:22:33:44:55:66', particles: ['adjective', 'noun'] });
'craven-delivery'

codenamize({ seed: '11:22:33:44:55:66', particles: ['noun', 'adjective', 'noun'] });
// 'satisfaction-craven-delivery'
```

### other options

These options can be used in either classic, or particles mode.

`options.maxItemChars` specifies the maximum length of each codename word.

```javascript
codenamize({ seed: '11:22:33:44:55:66', adjectiveCount: 2, maxItemChars: 3 });
// 'hot-shy-age'

codenamize({ seed: '11:22:33:44:55:66', adjectiveCount: 2, maxItemChars: 4 });
// 'even-cute-face'
```

`options.capitalize` determines whether each word in the codename will be capitalized.

```javascript
codenamize({ seed: '11:22:33:44:55:66', capitalize: true });
// 'Craven-Delivery'
```

`options.separator` specifies the character(s) used to combine the parts of the codename.

```javascript
codenamize({ seed: '11:22:33:44:55:66', separator: ':' });
// 'craven:delivery'
```

## Extending the codename vocabulary

Straight out of the box, **Codenamize** emulates the behaviour of the original [Python library](https://github.com/jjmontesl/codenamize), and contains the same noun and adjective lists. Generated codenames with either library should be identical for a given  input.

**Codenamize** can be extended with extra word lists with the `use` function. The `use` function takes a single object argument with keys representing each category of word, and values being arrays of words corresponding to the category.

```javascript
codenamize.use({ color: [ 'red', 'green', 'blue' ], animal: [ 'pig', 'dog', 'cat' ] });

codenamize({ seed: '11:22:33:44:55:66', particles: ['color', 'animal'] });
// 'blue-pig'
```

Note that in a real situation, a much more extensive list of words would likely be provide for each catagory of word.

# Other versions

* [Codenamize](https://github.com/jjmontesl/codenamize) - Python (the original!)
* [Concode](https://github.com/DannyBen/concode) - Ruby

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