Installation
npm install --save @types/unique-push-id
Summary
This package contains type definitions for unique-push-id (https://github.com/limit-zero/unique-push-id).
Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/unique-push-id.
index.d.ts
/**
* Fancy ID generator that creates 20-character string identifiers with the following properties:
*
* 1. They're based on timestamp so that they sort *after* any existing ids.
* 2. They contain 72-bits of random data after the timestamp so that IDs won't collide with other clients' IDs.
* 3. They sort *lexicographically* (so the timestamp is converted to characters that will sort properly).
* 4. They're monotonically increasing. Even if you generate more than one in the same timestamp, the
* latter ones will sort after the former ones. We do this by using the previous random bits
* but "incrementing" them by 1 (only in the case of a timestamp collision).
*
* @returns A unique, chronological, lexicographical 20-character string identifier.
*/
declare function pushId(): string;
export = pushId;Additional Details
- Last updated: Tue, 07 Nov 2023 15:11:36 GMT
- Dependencies: none
Credits
These definitions were written by Nathan Amick.