https://github.com/bryanmylee/zoo-ids

Generate predictable and unique identifiers composed of adjectives and animal names
https://github.com/bryanmylee/zoo-ids

adjectives animals generator id random seed style unique-identifiers

Last synced: 18 days ago
JSON representation

Generate predictable and unique identifiers composed of adjectives and animal names

• Host: GitHub
• URL: https://github.com/bryanmylee/zoo-ids
• Owner: bryanmylee
• Created: 2020-05-06T17:41:00.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-03-05T18:06:43.000Z (over 1 year ago)
• Last Synced: 2024-04-22T10:08:46.235Z (7 months ago)
• Topics: adjectives, animals, generator, id, random, seed, style, unique-identifiers
• Language: TypeScript
• Homepage:
• Size: 627 KB
• Stars: 12
• Watchers: 1
• Forks: 3
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
![zoo-ids](https://user-images.githubusercontent.com/42545742/102789911-b5b15d80-43df-11eb-9f42-7bfe245f7bf4.png)

[![npm version](http://img.shields.io/npm/v/zoo-ids.svg)](https://www.npmjs.com/package/zoo-ids)

[![npm downloads](https://img.shields.io/npm/dm/zoo-ids.svg)](https://www.npmjs.com/package/zoo-ids)

![license](https://img.shields.io/npm/l/zoo-ids)

![build](https://img.shields.io/github/actions/workflow/status/bryanmylee/zoo-ids/publish.yml)

[![coverage](https://coveralls.io/repos/github/bryanmylee/zoo-ids/badge.svg)](https://coveralls.io/github/bryanmylee/zoo-ids?branch=master)

[![size](https://img.shields.io/bundlephobia/min/zoo-ids)](https://bundlephobia.com/result?p=zoo-ids)

Generate **predictable** and **unique** identifiers composed of adjectives and animal names, with the ability to seed the random identifiers.

## Range of IDs

Currently, there are 1347 adjectives and 221 animals. The more adjectives used, the more possible combinations of IDs available.

For a quick reference, with 2 adjectives used, there are 400,984,389 possible unique IDs.

With 3 adjectives, there are 540,125,971,983 possible unique IDs.

## Installation

```bash

$ npm install zoo-ids

```

## Usage

### Examples

```js

import { generateId } from 'zoo-ids';

generateId('short seed'); // KnobbyNauticalKingfisher

// Any object can be used as a seed.

generateId(

	{ key: 'value' },

	{

		caseStyle: 'camelcase',

	}

); // weeklyGreatRacoon

// Defaults to the current time if seed is null.

generateId(null, {

	caseStyle: 'lowercase',

	delimiter: '🍓',

}); // enchanted🍓narrow🍓wallaby

```

### Documentation

#### `generateId(seed, opts?)`

##### `seed: any`

The seed used to generate the id. This allows us to generate predictable, but

random and unique identifiers.

Defaults to the current time in milliseconds.

##### `opts.numAdjectives: number`

The number of adjectives to use in the identifier.

Defaults to `2`.

##### `opts.delimiter: string`

The delimiter used between words. The delimiter will also be used between

multi-word adjectives.

Defaults to `''`.

##### `opts.caseStyle: string`

The case style for the words. Possible options are `'titlecase'`, `'camelcase'`, `'uppercase'`, `'lowercase'`, and `'togglecase'`.

```js

generateId('titlecase', { caseStyle: 'titlecase' }); // FineAntiqueElk

generateId('camelcase', { caseStyle: 'camelcase' }); // pertinentPoshGoldfinch

generateId('uppercase', { caseStyle: 'uppercase' }); // PIERCINGRESPONSIBLECAMEL

generateId('lowercase', { caseStyle: 'lowercase' }); // imaginarywingedsalamander

generateId('togglecase', { caseStyle: 'togglecase' }); // sTuNnInGdEsCrIpTiVepEaFoWl

```

Defaults to `'titlecase'`.

## Credits

This project was inspired by the url ids used by [gfycat.com](https://gfycat.com).

The seeded random number generator used is powered by the alea algorithm by

Johannes Baagøe ``, ported by [nquinlan/better-random-numbers-for-javascript-mirror](https://github.com/nquinlan/better-random-numbers-for-javascript-mirror/blob/master/support/js/Alea.js).