Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dailyrandomphoto/id-generators
id-generators is small JavaScript library to generate ID with awesome Unique ID libraries.
https://github.com/dailyrandomphoto/id-generators
Last synced: about 1 month ago
JSON representation
id-generators is small JavaScript library to generate ID with awesome Unique ID libraries.
- Host: GitHub
- URL: https://github.com/dailyrandomphoto/id-generators
- Owner: dailyrandomphoto
- License: mit
- Created: 2019-10-30T00:40:00.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2021-07-26T06:31:22.000Z (over 3 years ago)
- Last Synced: 2024-11-10T11:32:01.356Z (about 1 month ago)
- Language: JavaScript
- Size: 26.4 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# id-generators
[![NPM Version][npm-version-image]][npm-url]
[![LICENSE][license-image]][license-url]
[![Build Status][travis-image]][travis-url]
[![code style: prettier][code-style-prettier-image]][code-style-prettier-url]
**id-generators** is small JavaScript library to generate ID with awesome Unique ID libraries.
## Installation
```sh
npm install id-generators
```
## Usages
```js
const generators = require("id-generators");
const generator = generators.get("nanoid");
const generate = generator();
console.log("ID: " + generate());
// ID: gCa0wL_8ElTje5cwOci1d
console.log("ID: " + generate());
// ID: 5C_YAjgQl4iM3zK-TValY
console.log("ID: " + generate());
// ID: gQOOwCoQyfCuGK7fgINLd
```
If you want to customize ID, you can pass an option as an argument to the `generator` function.
```js
const generators = require("id-generators");
const generator = generators.get("nanoid-simple");
const generate = generator({ size: 25 });
console.log("ID: " + generate());
// ID: oa9wj0kfm50gv2qse8l5xup0u
console.log("ID: " + generate());
// ID: xn5ff5odiylg4jehhhp9vtlxv
console.log("ID: " + generate());
// ID: dff7ay5x38k1pkc2pxjv7elky
```
| generator type | ID length | character set | options/default | description |
| ------------------------------------------- | --------- | ------------------------ | --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| cuid (default) | 25 | `a-z0-9`, start with `c` | | use [`cuid()`](https://github.com/ericelliott/cuid) generated string.
e.g. `ck2bi7fxf00013ryng5jr1rer` |
| cuid-slug | 7-10 | `a-z0-9` | | use [`cuid.slug()`](https://github.com/ericelliott/cuid) generated string.
e.g. `xh23npi` |
| nanoid /
nanoid-good | 21 | `A-Za-z0-9_-` | size/21 | use [`nanoid()`](https://github.com/ai/nanoid) or [`nanoid-good`](https://github.com/y-gagar1n/nanoid-good) generated string.
e.g. `EwUTt2eoka-oEV5kf-o0O` |
| nanoid-simple /
nanoid-simple-good | 24 | `a-z0-9` | size/24 | use [`nanoid/generate`](https://github.com/ai/nanoid) or [`nanoid-good/generate`](https://github.com/y-gagar1n/nanoid-good) generated string.
e.g. `pfldm3gg8h9psydphotqe71d` |
| nanoid-lowercase /
nanoid-lowercase-good | 26 | `a-z` | size/26 | use [`nanoid/generate`](https://github.com/ai/nanoid) or [`nanoid-good/generate`](https://github.com/y-gagar1n/nanoid-good) generated string.
e.g. `jsjxoibprplrdoitjmppotjrnm` |
> If use `nanoid-good` or `nanoid-xxx-good`, you should install `nanoid-good` manually.
>
> ```sh
> npm install nanoid-good
> ```
## Define Custom Generators
This sample shows how to register a generator function.
The generator function should return a function that returns a ID.
```js
const { register } = require("id-generators");
register("my_custom_id", function (option) {
option = option || {};
let size = option.size || 8;
let prefix = option.prefix || "items-";
return function (title) {
return (
prefix + title.toLowerCase().replace(/[^\w]/g, "").substring(0, size)
);
};
});
```
```js
const generators = require("id-generators");
const generator = generators.get("my_custom_id");
const generate = generator({ size: 6 });
console.log("ID: " + generate("Hello World!"));
// ID: items-hellow
console.log("ID: " + generate("Foo Bar!"));
// ID: items-foobar
```
## Related
- [Awesome Unique ID](https://github.com/grantcarthew/awesome-unique-id) - A curated list of awesome Unique ID libraries and resources.
- [cuid](https://github.com/ericelliott/cuid) - Collision-resistant ids optimized for horizontal scaling and binary search lookup performance.
- [nanoid](https://github.com/ai/nanoid) - A tiny, secure, URL-friendly, unique string ID generator for JavaScript.
- [nanoid-good](https://github.com/y-gagar1n/nanoid-good) - Guarantees you will not get any obscene words or other profanity in your ids generated by [Nano ID](https://github.com/ai/nanoid).
## License
Copyright (c) 2019 [dailyrandomphoto][my-url]. Licensed under the [MIT license][license-url].
[my-url]: https://github.com/dailyrandomphoto
[npm-url]: https://www.npmjs.com/package/id-generators
[travis-url]: https://travis-ci.org/dailyrandomphoto/id-generators
[license-url]: LICENSE
[code-style-prettier-url]: https://github.com/prettier/prettier
[npm-downloads-image]: https://img.shields.io/npm/dm/id-generators
[npm-version-image]: https://img.shields.io/npm/v/id-generators
[license-image]: https://img.shields.io/npm/l/id-generators
[travis-image]: https://img.shields.io/travis/dailyrandomphoto/id-generators
[code-style-prettier-image]: https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square