README.md

ksuid

Generate prefixed, k-sorted globally unique identifiers. You can read more about them in our blog post.

Installation

$ yarn add @cuvva/ksuid

Usage

const ksuid = require('@cuvva/ksuid');

const id = ksuid.generate('user').toString();
// user_000000BgNwexbyo1VZs78wVMGdBo3

try {
	const parsed = ksuid.parse('user_000000BgNwexbyo1VZs78wVMGdBo3');
} catch (error) {
	console.log('uh oh!');
}

Testing

Install the development dependencies first:

$ yarn

Then run the tests 👩‍🔬:

$ yarn test

Support

Please open an issue on this repository.

License

MIT licensed - see LICENSE file