This package is part of the ⚡
Storm Stack monorepo. Storm Stack packages include CLI utility applications, tools, and various libraries used to create modern, scalable web applications.
💻 Visit stormsoftware.com to stay up to date with this developer
[!IMPORTANT]
This repository, and the apps, libraries, and tools contained within, is still in it's initial development phase. As a result, bugs and issues are expected with it's usage. When the main development phase completes, a proper release will be performed, the packages will be availible through NPM (and other distributions), and this message will be removed. However, in the meantime, please feel free to report any issues you may come across.
Be sure to ⭐ this repository on GitHub so you can keep up to date on any daily progress!
Table of Contents
Storm Unique Identifier Package
This package provides a simple way to generate various types of unique
identifiers. It is designed to be used in a browser or NodeJS environment.
Table of Contents
Installing
Using pnpm:
pnpm add -D @storm-stack/unique-identifier
Using npm
npm install -D @storm-stack/unique-identifier
Using yarn
yarn add -D @storm-stack/unique-identifier
Available Identifiers
This package includes generator functions for the following type of identifiers:
Identifier | Description | Details |
---|
Snowflake Identifier | Snowflakes are 64 bits in binary. (Only 63 are used to fit in a signed integer.) The first 41 bits are a timestamp, representing milliseconds since the chosen epoch. The next 10 bits represent a machine ID, preventing clashes. Twelve more bits represent a per-machine sequence number, to allow creation of multiple snowflakes in the same millisecond. The final number is generally serialized in decimal. | https://en.wikipedia.org/wiki/Snowflake_ID |
Universally Unique Identifier (UUID) | A universally unique identifier (UUID) is a 128-bit number used to identify information in computer systems. The term globally unique identifier (GUID) is also used, typically in software created by Microsoft. When generated according to the standard methods, UUIDs are for practical purposes unique. Their uniqueness does not depend on a central registration authority or coordination between the parties generating them, unlike most other numbering schemes. | https://en.wikipedia.org/wiki/Universally_unique_identifier |
Customer User Identifier (CUID) | Collision-resistant IDs optimized for horizontal scaling and performance. | https://support.appsflyer.com/hc/en-us/articles/207032016-Customer-User-ID-field-CUID- |
Reduced Package Size
This project uses tsup to package the source code
due to its ability to remove unused code and ship smaller javascript files
thanks to code splitting. This helps to greatly reduce the size of the package
and to make it easier to use in other projects.
Development
This project is built using Nx. As a result, many of the usual
commands are available to assist in development.
Building
Run nx build unique-identifier
to build the library.
Running unit tests
Run nx test unique-identifier
to execute the unit tests via
Jest.
Linting
Run nx lint unique-identifier
to run ESLint on the
package.
Storm Workspaces
Storm workspaces are built using
Nx, a set of extensible dev tools
for monorepos, which helps you develop like Google, Facebook, and Microsoft.
Building on top of Nx, the Open System provides a set of tools and patterns that
help you scale your monorepo to many teams while keeping the codebase
maintainable.
Roadmap
See the open issues for a
list of proposed features (and known issues).
Support
Reach out to the maintainer at one of the following places:
License
This project is licensed under the Apache License 2.0. Feel free to edit and
distribute this template as you like.
See LICENSE for more information.
Changelog
This project adheres to
Semantic Versioning. Every release, along
with the migration instructions, is documented in the CHANGELOG
file
Contributing
First off, thanks for taking the time to contribute! Contributions are what
makes the open-source community such an amazing place to learn, inspire, and
create. Any contributions you make will benefit everybody else and are greatly
appreciated.
Please try to create bug reports that are:
- Reproducible. Include steps to reproduce the problem.
- Specific. Include as much detail as possible: which version, what
environment, etc.
- Unique. Do not duplicate existing opened issues.
- Scoped to a Single Bug. One bug per report.
Please adhere to this project's code of conduct.
You can use
markdownlint-cli
to check for common markdown style inconsistency.
Contributors
Thanks goes to these wonderful people
(emoji key):
This project follows the
all-contributors
specification. Contributions of any kind welcome!
Fingerprint: 1BD2 7192 7770 2549 F4C9 F238 E6AD C420 DA5C 4C2D
Storm Software is an open source software development organization and creator
of Acidic, StormStack and StormCloud.
Our mission is to make software development more accessible. Our ideal future is
one where anyone can create software without years of prior development
experience serving as a barrier to entry. We hope to achieve this via LLMs,
Generative AI, and intuitive, high-level data modeling/programming languages.
Join us on Discord to chat with the team,
receive release notifications, ask questions, and get involved.
If this sounds interesting, and you would like to help us in creating the next
generation of development tools, please reach out on our
website or join our
Slack channel!