ts-essentials

ts-essentials

All essential TypeScript types in one place 🤙

Install

``sh
npm install --save-dev ts-essentials
`

👉 We require typescript>=4.5. If you're looking for support for older TS versions, please have a look at the
TypeScript dependency table

👉 As we really want types to be stricter, we require enabled
strictNullChecks in your project

API

ts-essentials is a set of high-quality, useful TypeScript types that make writing type-safe code easier.

$3

- Builtin - Matches primitive, function, date, error or regular expression
- KeyofBase -
keyofStringsOnly-tolerant analogue for PropertyKey
- Prettify - flattens type and makes it more readable on the hover in your IDE
- Primitive - Matches any
primitive value
- StrictExclude - Constructs a type by excluding from UnionType
all union members that are assignable to ExcludedMembers. This is stricter version of
Exclude
- StrictExtract - Constructs a type by extracting from Type all union members
that are assignable to Union. This is stricter version of
Extract
- StrictOmit - Constructs a type by picking all properties from Type and then
removing Keys. This is stricter version of
Omit
- Writable - Constructs a type with removed readonly for all properties of Type, meaning
the properties of the constructed type can be reassigned

$3

- AsyncOrSync - Constructs a type with Type or PromiseLike
- AsyncOrSyncType - Unwraps AsyncOrSync type
- Dictionary - Constructs a required object type which property keys are Keys
(string by default) and which property values are Type
- Merge - Constructs a type by picking all properties from Object1 and Object2.
Property values from Object2 override property values from Object1 when property keys are the same
- MergeN - Constructs a type by merging objects with type Merge in tuple Tuple recursively
- Newable - Constructs a class type with constructor which has return type ReturnType
- NonNever - Constructs a type by picking all properties from type Type which values don't
equal to never
- OmitProperties - Constructs a type by picking all properties from type Type
and removing those properties which values equal to Value
- Opaque - Constructs a type which is a subset of Type with a specified unique token
Token
- PathValue - Constructs a path value for type Type and path Path
- Paths - Constructs a union type by picking all possible paths for type Type
- PickProperties - Constructs a type by picking all properties from type Type
which values equal to Value
- SafeDictionary - Constructs an optional object type which property keys are
Keys (string by default) and which property values are Type
- UnionToIntersection - Constructs a intersection type from union type Union
- ValueOf - Constructs a type for type Type and equals to a primitive for primitives, array
elements for arrays, function return type for functions or object property values for objects
- XOR - Construct a type which is assignable to either type Type1,
Type2 but not both. Starting in ts-essentials@10, it supports up to 50 generic types.

$3

- MarkOptional - Constructs a type by picking all properties from type Type where
properties Keys are set as optional, meaning they aren't required
- MarkReadonly - Constructs a type by picking all properties from type Type where
properties Keys are set to readonly, meaning they cannot be reassigned
- MarkRequired - Constructs a type by picking all properties from type Type where
properties Keys are set as required
- MarkWritable - Constructs a type by picking all properties from type Type where
properties Keys remove readonly modifier, meaning they can be reassigned

$3

- Buildable - Constructs a type by combining DeepPartial and DeepWritable, meaning all
properties from type Type are recursively set as non-readonly and optional, meaning they can be reassigned and
aren't required
- DeepMarkOptional - Constructs a type by picking all properties from type Type where
properties by paths KeyPathUnion are set as optional. To mark properties optional on one level, use MarkOptional.
- DeepMarkRequired - Constructs a type by picking all properties from type Type where
properties by paths KeyPathUnion are set as required. To mark properties required on one level, use MarkRequired.
- DeepNonNullable - Constructs a type by picking all properties from type Type
recursively and exclude null and undefined property values from all of them. To make properties non-nullable on
one level, use NonNullable
- DeepNullable - Constructs a type by picking all properties from type Type recursively
and include null property values for all of them
- DeepOmit - Constructs a type by picking all properties from type Type and removing
properties which values are never or true in type Filter. If you'd like type Filter to be validated against a
structure of Type, please use StrictDeepOmit.
- DeepPartial - Constructs a type by picking all properties from type Type recursively
and setting them as optional, meaning they aren't required. To make properties optional on one level, use
Partial
- DeepPick - Constructs a type by picking set of properties, which have property
values never or true in type Filter, from type Type. If you'd like type Filter to be validated against a
structure of Type, please use StrictDeepPick.
- DeepReadonly - Constructs a type by picking all properties from type Type recursively
and setting readonly modifier, meaning they cannot be reassigned. To make properties readonly on one level, use
Readonly
- DeepRequired - Constructs a type by picking all properties from type Type recursively
and setting as required. To make properties required on one level, use
Required
- DeepUndefinable - Constructs a type by picking all properties from type Type
recursively and include undefined property values for all of them
- DeepWritable - Constructs a type by picking all properties from type Type recursively
and removing readonly modifier, meaning they can be reassigned. To make properties writable on one level, use
Writable
- StrictDeepOmit - Constructs a type by picking all properties from type Type
and removing properties which values are never or true in type Filter. The type Filter is validated against a
structure of Type.
- StrictDeepPick - Constructs a type by picking set of properties, which have
property values never or true in type Filter, from type Type. The type Filter is validated against a
structure of Type.

$3

- OptionalKeys - Constructs a union type by picking all optional properties of object type
Type
- PickKeys - Constructs a union type by picking all properties of object type Type
which values are assignable to type Value
- ReadonlyKeys - Constructs a union type by picking all readonly properties of object
type Type, meaning their values cannot be reassigned
- RequiredKeys - Constructs a union type by picking all required properties of object type
Type
- WritableKeys - Constructs a union type by picking all writable properties of object type
Type, meaning their values can be reassigned

$3

- Exact - Returns Type when type Type and Shape are identical. Otherwise returns
never
- IsAny - Returns true when type Type is any. Otherwise returns false
- IsNever - Returns true when type Type is never. Otherwise returns false
- IsUnknown - Returns true when type Type is unknown. Otherwise returns false
- IsTuple - Returns Type when type Type is tuple. Otherwise returns never
- NonEmptyObject