https://github.com/auth0/id-generator
Generates random ids with a prefix (a la Stripe)
https://github.com/auth0/id-generator
Last synced: 3 months ago
JSON representation
Generates random ids with a prefix (a la Stripe)
- Host: GitHub
- URL: https://github.com/auth0/id-generator
- Owner: auth0
- License: mit
- Created: 2015-02-05T16:13:40.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2023-02-16T12:34:48.000Z (over 2 years ago)
- Last Synced: 2025-03-29T16:07:32.605Z (4 months ago)
- Language: JavaScript
- Size: 55.7 KB
- Stars: 69
- Watchers: 110
- Forks: 17
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# id-generator
Generates random ids with a prefix (a la Stripe)
## Installing
```
npm i auth0-id-generator
```
## Using
Simple case:
```javascript
var IdGenerator = require('auth0-id-generator');
var generator = new IdGenerator();
var id = generator.new('cus');
console.log(id); // cus_lO1DEQWBbQAACfHO
```
Predefined set of allowed prefixes (to avoid mistakes):
```javascript
var IdGenerator = require('auth0-id-generator');
var generator = new IdGenerator(['cus', 'con']);
var 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):
```javascript
var IdGenerator = require('auth0-id-generator');
var generator = new IdGenerator(['cus', 'con']);
var id = generator.newUid(10);
console.log(id); // lO1DEQWBbQ
```
## New API
Updated api allows more customizations. Uses a new method `.get()`:
```javascript
var generator = new IdGenerator({len: 5, alphabet: 'abc123', prefix: 'foo', separator: ':'});
generator.get(); // -> foo:2a2b1
```
## Issue Reporting
If you have found a bug or if you have a feature request, please report them at this repository issues section. Please do not report security vulnerabilities on the public GitHub issue tracker. The [Responsible Disclosure Program](https://auth0.com/whitehat) details the procedure for disclosing security issues.
## Author
[Auth0](auth0.com)
## License
This project is licensed under the MIT license. See the [LICENSE](LICENSE) file for more info.