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.
A package containing various type checking functions and utility types
- Installing
- Reduced Package Size
- Development
- Storm Workspaces
- Roadmap
- Support
- License
- Changelog
- Contributing
- Contributors
Using pnpm:
pnpm add -D @storm-stack/typesUsing npm
npm install -D @storm-stack/typesUsing yarn
yarn add -D @storm-stack/typesThis 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.
This project is built using Nx. As a result, many of the usual commands are available to assist in development.
Run nx build types to build the library.
Run nx test types to execute the unit tests via Jest.
Run nx lint types to run ESLint on the package.
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.
See the open issues for a list of proposed features (and known issues).
- Top Feature Requests (Add your votes using the 👍 reaction)
- Top Bugs (Add your votes using the 👍 reaction)
- Newest Bugs
Reach out to the maintainer at one of the following places:
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.
This project adheres to Semantic Versioning. Every release, along with the migration instructions, is documented in the CHANGELOG file
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.
Thanks goes to these wonderful people (emoji key):
 Patrick Sullivan 🎨 💻 🔧 📖 |
 Tyler Benning 🎨 |
 Stormie 🚧 |
||||
Add your contributions
|
||||||
This project follows the all-contributors specification. Contributions of any kind welcome!
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!
