@cowprotocol/cow-sdk
Version:
<p align="center"> <img width="400" src="https://github.com/cowprotocol/cow-sdk/raw/main/docs/images/CoW.png" /> </p>
108 lines (81 loc) • 2.64 kB
Markdown
# scuid
[](https://npmjs.com/package/scuid)
[](https://npmjs.com/package/scuid)
[](https://npmjs.com/package/scuid)
[](https://travis-ci.org/jhermsmeier/node-scuid)
Collision-resistant IDs optimized for horizontal scaling and performance.
A slim, alternative, and compatible implementation of [cuid] for node,
also featuring a wide range of options, as well as custom random number generator support.
It can serve as a drop-in replacement, and is also faster than [cuid].
[cuid]: https://github.com/ericelliott/cuid
## Install via [npm](https://npmjs.com)
```sh
$ npm install --save scuid
```
## Usage
```js
var scuid = require( 'scuid' )
```
**Generate an ID**
```js
var id = scuid()
> 'ciux3hs0x0000io10cusdm8r2'
```
**Generate a slug**
```js
var slug = scuid.slug()
> '6x1i0r0'
```
**Get the process' fingerprint**
```js
var fingerprint = scuid.fingerprint()
> 'io10'
```
**Use a custom (P)RNG**
```js
// Create a random number generator;
// It has to have a method called `random`
var generator = {
random: function() {
return 5 // chosen by fair dice roll
}
}
// Create a custom scuid instance
var scuid = require( 'scuid' ).create({
rng: generator
})
```
**Use other custom options**
Note that fiddeling with these might make your IDs incompatible with [cuid]'s guarantees.
```js
var scuid = require( 'scuid' ).create({
prefix: 'c', // the ID's prefix
base: 36, // radix used in .toString() calls (2-36)
blockSize: 4, // block size to pad and trim to
fill: '0', // block padding character
pid: process.pid, // process ID
fingerprint: scuid.createFingerprint( [pid], [hostname] ), // Machine fingerprint
rng: Math, // Random number generator
})
```
## Tests
Just like `cuid`, collision resistance for both – slugs and IDs – is tested
over 1 million and 2 million iterations respectively.
To run the tests, run:
```
$ npm test
```
## Benchmarks
```
$ npm run benchmark
```
```
scuid
id ............................................. 573,618 op/s
slug ........................................... 673,732 op/s
fingerprint .................................... 131,156,394 op/s
cuid
id ............................................. 445,260 op/s
slug ........................................... 531,770 op/s
fingerprint .................................... 125,159,685 op/s
```