ts-toolbelt
Advanced tools
The ts-toolbelt package provides a comprehensive set of type utilities to improve TypeScript typing and enable type transformations, checks, and more complex operations. It enhances TypeScript's static typing capabilities and helps in building more robust type-safe applications.
Object Manipulation
Merge two types into one. This is useful for combining properties from multiple objects into a single type.
{ type Merged = Merge<{name: string}, {age: number}>; // Result: {name: string, age: number} }Type Checking
Check if two types are equivalent. This utility helps in validating type structures for consistency.
{ type check = Equals<{a: string}, {a: string, b: number}>; // Result: false }Conditional Types
Apply conditional logic to types. This feature allows for conditional type assignments based on certain conditions.
{ type Conditional = If<true, 'Yes', 'No'>; // Result: 'Yes' }Provides a collection of utility types for TypeScript, similar to ts-toolbelt. While utility-types focuses more on transformations and mappings, ts-toolbelt offers a broader range of type operations including type checks and advanced manipulations.
A package that includes a variety of utility types for TypeScript. Type-fest is similar to ts-toolbelt but tends to be simpler and more focused on everyday use cases, whereas ts-toolbelt provides more comprehensive and complex utilities for advanced type manipulation.
📖 Documentation · 📣 Announcements · 🐞 Report Bug · 🍩 Request Feature · 🤔 Ask Questions
ts-toolbelt is the largest, and most tested type library available right now, featuring +200 utilities. Our type collection packages some of the most advanced mapped types, conditional types, and recursive types on the market.
Spend less time, build stronger. Benefit from a wide range of generic type functions to achieve better type safety.
We work just like lodash, or ramda, but applied to the type system. Our mission is to provide you with simple ways to compute, change, and create types. We abstract all those complex type checks away for you. We provide a simple, reusable, and standard API to help you get more done with TypeScript.
ts-toolbelt is a well organized package that can help you perform advanced operations on object types, union types, as well as function, and literal types. It is carefully and coherently designed for building robust, flexible, and type-safe software.
We are a community and a knowledge base. Everyone is welcome to ask questions about types. If you are stuck or you misunderstand something, you came to the right place!. We welcome beginners and advanced developers to come take part. Welcome!
npm install typescript@^4.1.0 --save-dev
For best results, add this to your tsconfig.json
{
"compilerOptions": {
// highly recommended (required by few utilities)
"strictNullChecks": true,
// this is optional, but enable whenever possible
"strict": true,
// this is the lowest supported standard library
"lib": ["es2015"],
}
}
npm install ts-toolbelt --save
import {Object} from "ts-toolbelt"
// Check the docs below for more
// Merge two `object` together
type merge = Object.Merge<{name: string}, {age?: number}>
// {name: string, age?: number}
// Make a field of an `object` optional
type optional = Object.Optional<{id: number, name: string}, "name">
// {id: number, name?: string}
You can level-up, and re-code this library from scratch.
The project is organized around TypeScript's main concepts:
| Any | Boolean | Class | Function | Iteration | List |
|---|---|---|---|---|---|
| Number | Object | Object.P | String | Union | Test |
TIPHow to choose categories? Match your type with them.
There are many ways to import the types into your project:
Explicit
import {Any, Boolean, Class, Function, Iteration, List, Number, Object, String, Union} from "ts-toolbelt"
Compact
import {A, B, C, F, I, L, N, O, S, U} from "ts-toolbelt"
Portable
import tb from "ts-toolbelt"
You can also import our non-official API from the community:
import {Community} from "ts-toolbelt"
TIPThe community API is for our community to publish useful types that don't see fit in the standard API.
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.
To run the lint & type tests, simply run:
npm test
Want to test your own types? Let's get started:
import {Number, Test} from "ts-toolbelt"
const {checks, check} = Test
checks([
check<Number.Add<1, 30>, 31, Test.Pass>(),
check<Number.Add<5, -3>, 2, Test.Pass>(),
])
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:
npm testThe project is maintained to adapt to the constant changes of TypeScript:
| ts-toolbelt | typescript |
|---|---|
| 9.x.x | ^4.1.x |
Major version numbers will upgrade whenever TypeScript had breaking changes.
Otherwise, the release versions will naturally follow the semantic versioning.
Automated performance tests
# performance is checked manually with
npx tsc --noEmit --extendedDiagnostics
Need to write more examples
| Name | Intro |
|---|---|
eledoc | 🌒 A material dark theme for TypeDoc. |
material-candy | 🍬 A vscode theme to uplift your mood, stay happy and focused. |
utility-types | Collection of utility types, complementing TypeScript built-in mapped types and aliases. |
9.6.0 (2021-03-10)
FAQs
TypeScript's largest utility library
The npm package ts-toolbelt receives a total of 3,961,390 weekly downloads. As such, ts-toolbelt popularity was classified as popular.
We found that ts-toolbelt demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
PyPI confirms no security flaws were exploited in the Ultralytics supply chain attack and highlights improvements for safer package publishing.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.