js/snowflake-uid
2
0
Fork 0
generated from templates/typescript-library
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

readme
All checks were successful
Build and test / build-and-test (18.x) (push) Successful in 13s
Details
Build and test / build-and-test (20.x) (push) Successful in 15s
Details

Browse Source
This commit is contained in:
James Brumond 2023-08-26 16:11:22 -07:00
parent abfbabf71f
commit 0f053e7787
Signed by: james
GPG Key ID: E8F2FC44BAA3357A
1 changed files with 15 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
readme.md
View File

@ -1,11 +1,25 @@
Utility for generating Snowflake UIDs (see: <https://en.wikipedia.org/wiki/Snowflake_ID>) Utility for generating Snowflake UIDs (see: <https://en.wikipedia.org/wiki/Snowflake_ID>)
Features:
- **Zero** dependencies
- Configurable epoch time
- Configurable instance size, allowing timestamp and sequence to be larger
--- ---
## Install ## Install
<!-- --> ```bash
# Update project npm config to refer to correct registry for the @js scope
echo '@js:registry=https://gitea.jbrumond.me/api/packages/js/npm/' >> ./.npmrc
npm install --save @js/snowflake-uid
# optional - additional supporting typescript definitions
npm install --save-dev @js/types
```