Higher Type Safety for TypeScript. A collection of useful types.
Table of Contents
- 📜 About
- 🍩 Features
- 🏁 Getting started
- 📖 Documentation
- 🧠 Good to know
- 📣 Announcements
- 🎁 Contributing
- 💉 Running tests
- 🔧 Compatibility
- 👏 Sponsoring issues
- 🔮 What's next
- 🙏 Acknowledgements
"Avoid bugs by writing high quality types"
ts-toolbelt ships utility types that provide simple ways to update, change, and compute TypeScript types. It offers unique dynamic features, allowing you to write type-safe software more easily and in less time than you do today.
Its programmatic API brings new capabilities to TypeScript with +200 tested type utilities. This makes it the largest and the most reliable type collection out there. It uses the type system itself for TypeScript to compute complex types. So its API exposes types that trade CPU & RAM for higher type safety.
- Answer the question to "How can I do this in TypeScript?"
- Provide a programmatic standard API for the type system
- Promote type evolution/reusability within your codebase
- Software that is more type-safe, flexible, and robust
- Bring a whole new set of extra features to TypeScript
- Extensively tested type utilities for maximum type safety
- This package aims to be the home of all utility types
- Answer questions about types and share knowledge
You'll find all the types you can ever need in this single and well organized package.
Here's some of the most useful utilities:
- Merge two types together
- Update the field of a type
- Make some fields optional
- Change a type at any depth!
- Concat two lists together
- Get the last item of a list
TIPIf you don't find the type you are looking for, you are welcome to open a feature request!
🏁 Getting Started
Lowest TypeScript support starts at v3.5
npm install typescript@^3.8.0 --save-dev
For best results, add this to your
npm install ts-toolbelt --save
// Check the docs below for more// Merge two `object` together
TIPYou can also grab the demo over here.
Where to start
To get you started, we recommend that you visit the documentation of the following essential tools.
The documentation is complete but it needs more examples. So feel free to ask for examples.
The project is organized around TypeScript's main concepts:
TIPHow to choose categories? Match your type with them.
There are many ways to import the types into your project:
You can also import our non-official API from the community:
TIPThe community API is for our community to publish useful types that don't see fit in the standard API.
If you're interested to learn how the internals work, this tutorial will get you on track to start writing your own types.
Access older docs at https://millsp.github.io/ts-toolbelt/version/
In this wiki, you will find some extra resources for your learning, and understanding.
Are you missing something? Participate to the open-wiki by posting your questions.
Stay up to date with the latest announcements with this regular digest of important changes.
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated. There are many ways to contribute to the project:
- Improving existing documentation
- Adding new types to the collection
- Getting involved with things to do
Fork the project
Clone your fork
Create a pr/feature branchgit checkout -b pr/CoolFeature
Commit your changes
You must follow the conventional commit to be able to commitgit commit -m "feat(name): Added this CoolFeature"
Push your changesnpm run release -- --no-tags
Open a pull request
💉 Running tests
For this project
To run the
type tests, simply run:
For your project
Want to test your own types? Let's get started:
TIPPlace it in a file that won't be executed, it's just for TypeScript to test types.
The releases are done with Travis CI in stages & whenever a branch or PR is pushed:
- Tests are run with
- Tests against DefinitelyTyped
- Releases to npm@[branch-name]
If you wrote tests & would like your project to be tested too, please open an issue.
The project is maintained to adapt to the constant changes of TypeScript:
Major version numbers will upgrade whenever TypeScript had breaking changes (it happened that TS had breaking changes on minor versions). Otherwise, the release versions will naturally follow the semantic versioning.
👏 Sponsoring issues
Sponsored issues have higher priority over non-critical issues.
You can either request a new feature or a bug fix, and then fund it.
The money will be transparently split with an issue's assignees.
🔮 What's next
Automated performance tests# performance is checked manually withnpx tsc --noEmit --extendedDiagnostics
Need to write more examples
Many, many thanks to all the contributors and:
- André Staltz
- Joe Calzaretta
- Matt McCutchen
- Monroe Ekilah
- Nathan S.-Sanders
- Regev Brody
- Titian C.-Dragomir
💟 Friendly Projects
eledoc- 🌒 A material dark theme for TypeDoc
utility-types- Collection of utility types, complementing TypeScript built-in mapped types and aliases