Skip to content
๐Ÿ‘ท Higher type safety for TypeScript
Branch: master
Clone or download
Latest commit a9bc5e3 Jul 2, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github readme Jun 26, 2019
docs Release 3.0.0-1 Jul 1, 2019
src restored Max/Min Jul 1, 2019
tst restored Max/Min Jul 1, 2019
.eslintrc.json initial commit Jun 8, 2019
.gitignore release Jun 17, 2019
.npmignore peerdependency Jun 9, 2019
.travis.yml add release-it Jun 18, 2019
LICENSE release Jun 17, 2019
README.md Update README.md Jul 2, 2019
logo.psd readme Jun 18, 2019
package.json Release 3.0.0-1 Jul 1, 2019
tsconfig.json readme+doc Jun 9, 2019

README.md

logo

ts-toolbelt

๐Ÿ‘ท Higher type safety for TypeScript
Explore the docs ยป

๐ŸŽฎ View Demo ยท ๐Ÿž Report Bug ยท ๐Ÿฉ Request Feature . ๐Ÿค” Ask Questions

Table of Contents

๐Ÿ“œ About

ts-toolbelt is a collection of types that makes TypeScript even safer. 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.

ts-toolbelt completes TypeScript with a collection of more than 150 tested types.

Goals

  • This package aims to be the home of all utility types
  • High performance, so it will not bloat TS (max +4sec)
  • Computed types are always readable, like if you typed it
  • 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!

๐Ÿฉ Features

Here's some of the most useful features:

If you don't find the type you are looking for, you are welcome to open a feature request!

๐Ÿ Getting Started

Prerequisites

This is important, the lowest TypeScript version that is supported is 3.5

npm install typescript@^3.5.0 --save

Installation

npm install ts-toolbelt --save

Hello World

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}>

๐Ÿ“– Documentation โคข

The project is organized around TypeScript's main concepts:

A(ny) B(boolean) C(lass) F(unction) I(teration) N(umber)
O(bject) O(bject).P S(tring) T(uple) U(nion) Test

Imports

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'

Internal Docs

If you're interested to learn how the internals work, this tutorial will get you on track to start writing your own types.

๐Ÿง  Good to Know โคข

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.

Questions โคข

Are you missing something? Participate to the open-wiki by posting your questions right here.

๐ŸŽ Contributing

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:

Community

Codebase

  • Improving existing documentation
  • Adding new types to the collection

Pull Requests

  1. Read the tutorial
  2. Fork the project
  3. Clone your fork
  4. Create a pr/feature branch
    git checkout -b pr/CoolFeature
  5. Commit your changes
    git commit -m 'Added this CoolFeature'
  6. Run the tests
  7. Commit your changes
    git push origin pr/CoolFeature
  8. Open a pull request

๐Ÿ‘ Sponsoring issues

Sponsored issues have higher priority over non-critical issues.

You can either request a new feature or a bug fix then fund it.



The money will be transparently split with an issue's assignees.

๐Ÿ’‰ Running tests

For this project

To run the lint & type tests, simply run:

npm test

For your project

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>(),
])

Place it in a file that won't be executed, it's just for TypeScript to test types

๐Ÿ”ง Compatibility

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

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 semantic versioning.

๐Ÿ”ฎ What's next

  • Automated performance tests
    # performance is checked manually with 
    npx tsc --noEmit --extendedDiagnostics
  • Improve with user feedback
  • Need to write the examples

๐Ÿ™ Acknowledgements

Many, many thanks to all the contributors and:

๐Ÿ’Ÿ Friendly Projects

  • utility-types - Collection of utility types, complementing TypeScript built-in mapped types and aliases
You canโ€™t perform that action at this time.