๐ท All the types you need for TypeScript
Explore the docs ยป
๐ฎ View Demo
ยท
๐ Report Bug
ยท
๐ฉ Request Feature
ยท
๐ค Ask Questions
- ๐ About
- ๐ฉ Features
- ๐ Getting started
- ๐ Documentation
- ๐ง Good to know
- ๐ Contributing
- ๐ Sponsoring issues
- ๐ Running tests
- ๐ง Compatibility
- ๐ฎ What's next
- ๐ Acknowledgements
ts-toolbelt completes TypeScript with a collection of more than 200 tested types. This makes it the largest, and most reliable type collection out there.
It's goal is to improve type correctness while adding a whole new set of features to TypeScript. It uses the type system itself for TypeScript to compute more complex types. In other words, its API exposes types that trade CPU & RAM for higher type safety.
- Answer the question to "How do I do this in TypeScript?"
- Software that's more type-safe, flexible & more robust
- Bring a whole new set of extra features to TypeScript
- Types can be combined together to create new ones!
- This package aims to be the home of all utility types
- Computed types are always readable, like if you typed it
- High performance, so it will not bloat TS (~ +2sec, +50MB)
Here's some of the most useful features:
- Merge two types together
- Update the field of a type
- Make some fields optional
- Change a type at any depth!
- Concat two tuples together
- Get the last item of a tuple
- ... and so much more
TIP
If you don't find the type you are looking for, you are welcome to open a feature request!
Lowest TypeScript support starts at v3.5
npm install typescript@^3.6.0 --save
For best results, add this to your tsconfig.json
// Optional, recommended
{
"compilerOptions": {
// ...
"strict": true
}
}
npm install ts-toolbelt --save
import {A, B, C, F, I, N, O, S, T, U} from 'ts-toolbelt'
// Wonder what these letters mean? Check the docs below
// Merge two `object` together
type merge = O.Merge<{name: string}, {age?: number}>
The project is organized around TypeScript's main concepts:
Any | Boolean | Class | Function | Iteration | Number |
Object | Object.P | String | Tuple | Union | Test |
TIP
match the type kind you need to operate on with the above categories
The documentation is complete but needs more examples. So feel free to ask for examples, and I will update the docs.
There are many ways to import the types into your project:
-
Explicit
import {Any, Boolean, Class, Function, Iteration, Number, Object, String, Tuple, Union} from 'ts-toolbelt'
-
Compact
import {A, B, C, F, I, N, O, S, T, U} from 'ts-toolbelt'
-
Portable
import tb from 'ts-toolbelt'
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://pirix-gh.github.io/ts-toolbelt/version/
In this wiki, you'll find some extra resources for your learning & understanding.
It is incremental and it will be completed on demand, you can ask for this below.
Are you missing something? Participate to the open-wiki by posting your questions right here.
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
-
Fork the project
-
Clone your fork
-
Create a pr/feature branch
git checkout -b pr/CoolFeature
-
Commit your changes
You must follow the conventional commit to be able to commit
git commit -m 'feat(name): Added this CoolFeature'
-
Push your changes
npm run release -- --no-tags
-
Open a pull request
Sponsored issues have higher priority over non-critical issues.
You can either request a new feature or a bug fix then fund it.
![](https://raw.githubusercontent.com/pirix-gh/ts-toolbelt/master/.github/issuehunt.png)
The money will be transparently split with an issue's assignees.
To run the lint
& type
tests, simply run:
npm test
Want to test your own types? Let's get started:
import {A, B, C, F, I, N, O, S, T, U, Test} from 'ts-toolbelt'
const {checks, check} = Test
checks([
check<N.Plus<'1', '30'>, '31', Test.Pass>(),
check<N.Plus<'5', '-3'>, '2', Test.Pass>(),
])
TIP
Place 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
npm test
- 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:
ts-toolbelt | typescript |
---|---|
1.x.x | ~3.5.x |
2.x.x | ^3.5.x |
3.x.x | ^3.5.x |
4.x.x | ^3.6.x |
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.
- Automated performance tests
# performance is checked manually with npx tsc --noEmit --extendedDiagnostics
- Improve with user feedback
- Need to write the examples
Many, many thanks to all the contributors and:
eledoc
- ๐ A material dark theme for TypeDocutility-types
- Collection of utility types, complementing TypeScript built-in mapped types and aliases