Skip to content

Add documentation to Config Interface parameters #10

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 24, 2021
Merged

Add documentation to Config Interface parameters #10

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions src/generateUniqueID.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,17 @@ const CUSTOM_EPOCH = 1546300800000; // 01-01-2019
const MAX_MACHINE_ID = (1 << 12) - 1;

interface Config {
/**
* Defaults to 1546300800000 (01-01-2019). This is UNIX timestamp in ms
*/
customEpoch?: number;
/**
* Defaults to false. If set to true, the returned ids will be of type BigInt or else of type string
*/
returnNumber?: boolean;
/**
* A value ranging between 0 - 4095. If not provided then a random value will be used
*/
machineID?: number;
}

Expand Down