https://github.com/dirkluijk/typescript-essentials
Must-have utility types and functions for TypeScript
https://github.com/dirkluijk/typescript-essentials
Last synced: about 1 year ago
JSON representation
Must-have utility types and functions for TypeScript
- Host: GitHub
- URL: https://github.com/dirkluijk/typescript-essentials
- Owner: dirkluijk
- License: mit
- Created: 2020-08-30T21:46:01.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2020-09-06T13:29:54.000Z (almost 6 years ago)
- Last Synced: 2025-06-07T04:04:55.139Z (about 1 year ago)
- Language: TypeScript
- Size: 221 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Typescript Essentials
> Must-have utility types and functions for TypeScript
[](https://www.npmjs.com/package/typescript-essentials)
[](https://www.npmjs.com/package/typescript-essentials)
[](https://travis-ci.org/dirkluijk/typescript-essentials)
[](#contributors-)
## Overview
This is a small util library which contains several types and functions that may
be useful in your TypeScript project.
## Getting started 🌩
##### npm
```
npm install typescript-essentials
```
##### yarn
```
yarn add typescript-essentials
```
## Contents
### Predicates & type-guards
Useful to compose simple predicates, or to narrow types in arrays or other data structures.
* [`Predicate` and `TypeGuard` interfaces](projects/typescript-essentials/src/lib/predicates/predicates.md)
* [`not()` function](projects/typescript-essentials/src/lib/predicates/predicates.md) to negate predicates
* [`matchesDiscriminator()` function](projects/typescript-essentials/src/lib/predicates/predicates.md) that returns a type guard
* [`isNull()` type guard](projects/typescript-essentials/src/lib/predicates/predicates.md)
* [`isUndefined()` type guard](projects/typescript-essentials/src/lib/predicates/predicates.md)
* [`isNullOrUndefined()` type guard](projects/typescript-essentials/src/lib/predicates/predicates.md)
* [`isNotNull()` type guard](projects/typescript-essentials/src/lib/predicates/predicates.md)
* [`isNotUndefined()` type guard](projects/typescript-essentials/src/lib/predicates/predicates.md)
* [`isNotNullOrUndefined()` type guard](projects/typescript-essentials/src/lib/predicates/predicates.md)
### Generics
* [`DiscriminatedUnion`](projects/typescript-essentials/src/lib/generics/generics.md) to narrow a union type using a discriminator field
* [`Narrowable`](projects/typescript-essentials/src/lib/generics/generics.md) to identify a type that can be narrowed
* [`Subtract`](projects/typescript-essentials/src/lib/generics/generics.md) to subtract types from one another
* [`WithOptional`](projects/typescript-essentials/src/lib/generics/generics.md) to make certain properties optional
### Array utils
* [`uniqueValues()`](projects/typescript-essentials/src/lib/arrays/arrays.md)
* [`exclude()`](projects/typescript-essentials/src/lib/arrays/arrays.md)
* [`partition()`](projects/typescript-essentials/src/lib/arrays/arrays.md)
### Object utils
* [`omit()`](projects/typescript-essentials/src/lib/objects/objects.md)
### Ordered
* [`Ordered` interface](projects/typescript-essentials/src/lib/ordering/ordering.md)
* [`compareByOrder()` comparator function](projects/typescript-essentials/src/lib/ordering/ordering.md)
### "Track by" functions for Angular
* [`trackByIndex`](projects/typescript-essentials/src/lib/angular/angular.md)
* [`trackById`](projects/typescript-essentials/src/lib/angular/angular.md)
* [`trackByValue`](projects/typescript-essentials/src/lib/angular/angular.md)
* [`createTrackByFn`](projects/typescript-essentials/src/lib/angular/angular.md)
## Contributors ✨
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
Dirk Luijk
💻 📖
Daan Scheerens
🤔
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!