/stripe-id-generator

Generates random ids with a prefix (a la Stripe)

Primary LanguageTypeScriptMIT LicenseMIT

stripe-id-generator

Sanity check Coverage Status styled with prettier

Generates random ids with a prefix (a la Stripe) for Node.Js

Installing

npm i stripe-id-generator # or
yarn add stripe-id-generator

Using

Simple case:

const IdGenerator = require('stripe-id-generator');

const generator = new IdGenerator();
const id = generator.new('cus');

console.log(id); // cus_lO1DEQWBbQAACfHO

Predefined set of allowed prefixes (to avoid mistakes):

const IdGenerator = require('stripe-id-generator');

const generator = new IdGenerator(['cus', 'con']);
const id = generator.new('cus');

console.log(id); // cus_lO1DEQWBbQAACfHO

generator.new('cli'); // throws

To get a uid (id with a given length and without prefix):

const IdGenerator = require('stripe-id-generator');

const generator = new IdGenerator(['cus', 'con']);
const id = generator.newUid(10);

console.log(id); // lO1DEQWBbQ

Author

Fork from Auth0

License

This project is licensed under the MIT license. See the LICENSE file for more info.