Returns a function to generate unique ids.
The function can accept one of the following parameters:
fixedLength: Boolean
If fixedLength is true the function will always generate an id
that is 33 characters in length, by default fixedLength is false.
options: Object
If { fixedLength: true } is passed in, the function will always generate an id
that is 33 characters in length, by default fixedLength is false.
If { urlSafe: true } is passed in, the function will generate url safe ids according to RFC4648.
If { startFrom: <int> } is passed in, the first counter will start from that
number, which must be between 0 and 2147483647. Fractions are discarded, only the
integer part matters.
If { maxInt: <int> } is passed in, the uuid will be re-generated once the maxInt is reached. The lesser the maxInt, higher the performance because of SMI (a V8 optimization).
instance()
Returns an unique id.
instance.uuid
The uuid used to generate the ids, it will change over time.
If maxInt is provided in options, then it will regenerated every maxInt, else it will be regenerated every Math.pow(2, 31) - 1 to keep the integer a SMI (a V8 optimization).
hyperid.decode(id, [options])
Decode the unique id into its two components, a uuid and a counter.
If you are generating url safe ids, you must pass { urlSafe: true } as option.
It returns: