https://github.com/basementuniverse/shortuid

Generate short unique IDs
https://github.com/basementuniverse/shortuid

Last synced: 23 days ago
JSON representation

Generate short unique IDs

• Host: GitHub
• URL: https://github.com/basementuniverse/shortuid
• Owner: basementuniverse
• License: mit
• Created: 2021-06-01T18:43:06.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2023-11-04T00:05:35.000Z (about 1 year ago)
• Last Synced: 2024-04-13T17:37:21.205Z (9 months ago)
• Language: TypeScript
• Size: 53.7 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Short UID

Generate short unique IDs from sequential numbers.

The short unique IDs can be converted back to the original sequential numbers.

This can be useful when you have an auto-increment ID column in your database, but you want to show a short alpha-numeric ID to users.

With this package you can convert sequential numbers to random-looking ID strings and back again.

## Installation

```

npm install -g @basementuniverse/shortuid

```

## Usage

```typescript

import Shortuid, { ShortuidOptions } from '@basementuniverse/shortuid';

const options: ShortuidOptions = {

  // This should be a large prime number, coprime to base

  // Try using https://primes.utm.edu/curios/index.php to find a suitable prime

  prime: '6345796823',

  // This should be a large integer

  // It will define the size of the input domain, i.e. any inputs larger than base will result in duplicate ids

  // Try using https://codinglab.huostravelblog.com/math/coprime-finder/index.php to find coprimes of prime

  base: '10212011',

  // The multiplicative modular inverse of prime modulo base

  // Try using https://planetcalc.com/3311/ to find this value

  inverse: '3736125',

  // A large random number used to mix the output and add more entropy

  // It must be larger than base

  mixer: '28737113',

  // A string containing all the characters that you want to see in the output

  // Try using shuffled alphanumeric characters to add more entropy

  // You may also wish to remove some hard-to-distinguish characters ('i', 'l', '1', '0', 'o' etc.)

  alpha: '568vhgxrwkfjyn9d3pc2mqbaz74set',

};

const numericId = 1;

const encodedShortId = Shortuid.encode(numericId, options);

// encodedShortId will be a short id string, similar to 'f85k8'

const decodedNumericId = Shortuid.decode(encodedShortId, options);

console.assert(decodedNumericId === numericId);

```

Some helper scripts are provided which might be useful for generating options:

```bash

cd helpers

# Generate prime, base, inverse and mixer:

node generate-options.js

# Generate a random alphabet:

node generate-alphabet.js

# Check for collisions:

node check-collisions.js

```