\n\n\n## Install\n\n```sh\nnpm install --save-dev ts-essentials\n```\n\n???? We require `typescript>=4.5`. If you're looking for support for older TS versions, please have a look at the\n[TypeScript dependency table](https://github.com/ts-essentials/ts-essentials/tree/master#TypeScript-dependency-table)\n\n???? As we really want types to be stricter, we require enabled\n[strictNullChecks](https://www.typescriptlang.org/tsconfig#strictNullChecks) in your project\n\n## API\n\n`ts-essentials` is a set of high-quality, useful TypeScript types that make writing type-safe code easier.\n\n### Basic\n\n- [`Builtin`](/lib/built-in) - Matches primitive, function, date, error or regular expression\n- [`KeyofBase`](/lib/key-of-base) -\n [`keyofStringsOnly`](https://www.typescriptlang.org/tsconfig#keyofStringsOnly)-tolerant analogue for `PropertyKey`\n- [`Prettify`](/lib/prettify/) - flattens type and makes it more readable on the hover in your IDE\n- [`Primitive`](/lib/primitive) - Matches any\n [primitive value](https://developer.mozilla.org/en-US/docs/Glossary/Primitive)\n- [`StrictExclude`](/lib/strict-exclude) - Constructs a type by excluding from `UnionType`\n all union members that are assignable to `ExcludedMembers`. This is stricter version of\n [`Exclude`](https://www.typescriptlang.org/docs/handbook/utility-types.html#excludeuniontype-excludedmembers)\n- [`StrictExtract`](/lib/strict-extract) - Constructs a type by extracting from `Type` all union members\n that are assignable to `Union`. This is stricter version of\n [`Extract`](https://www.typescriptlang.org/docs/handbook/utility-types.html#extracttype-union)\n- [`StrictOmit`](/lib/strict-omit) - Constructs a type by picking all properties from `Type` and then\n removing `Keys`. This is stricter version of\n [`Omit`](https://www.typescriptlang.org/docs/handbook/utility-types.html#omittype-keys)\n- [`Writable`](/lib/writable) - Constructs a type with removed `readonly` for all properties of `Type`, meaning\n the properties of the constructed type can be reassigned\n\n### Utility types\n\n- [`AsyncOrSync`](/lib/async-or-sync) - Constructs a type with `Type` or `PromiseLike`\n- [`AsyncOrSyncType`](/lib/async-or-sync-type) - Unwraps `AsyncOrSync` type\n- [`Dictionary`](/lib/dictionary) - Constructs a required object type which property keys are `Keys`\n (`string` by default) and which property values are `Type`\n- [`Merge`](/lib/merge) - Constructs a type by picking all properties from `Object1` and `Object2`.\n Property values from `Object2` override property values from `Object1` when property keys are the same\n- [`MergeN`](/lib/merge-n) - Constructs a type by merging objects with type `Merge` in tuple `Tuple` recursively\n- [`Newable`](/lib/newable) - Constructs a class type with constructor which has return type `ReturnType`\n- [`NonNever`](/lib/non-never) - Constructs a type by picking all properties from type `Type` which values don't\n equal to `never`\n- [`OmitProperties`](/lib/omit-properties) - Constructs a type by picking all properties from type `Type`\n and removing those properties which values equal to `Value`\n- [`Opaque`](/lib/opaque) - Constructs a type which is a subset of `Type` with a specified unique token\n `Token`\n- [`PathValue`](/lib/path-value) - Constructs a path value for type `Type` and path `Path`\n- [`Paths`](/lib/paths) - Constructs a union type by picking all possible paths for type `Type`\n- [`PickProperties`](/lib/pick-properties) - Constructs a type by picking all properties from type `Type`\n which values equal to `Value`\n- [`SafeDictionary`](/lib/safe-dictionary) - Constructs an optional object type which property keys are\n `Keys` (`string` by default) and which property values are `Type`\n- [`UnionToIntersection`](/lib/union-to-intersection) - Constructs a intersection type from union type `Union`\n- [`ValueOf`](/lib/value-of) - Constructs a type for type `Type` and equals to a primitive for primitives, array\n elements for arrays, function return type for functions or object property values for objects\n- [`XOR`](/lib/xor) - Construct a type which is assignable to either type `Type1`,\n `Type2` but not both. Starting in ts-essentials@10, it supports up to 50 generic types.\n\n### Mark wrapper types\n\n- [`MarkOptional`](/lib/mark-optional) - Constructs a type by picking all properties from type `Type` where\n properties `Keys` are set as optional, meaning they aren't required\n- [`MarkReadonly`](/lib/mark-readonly) - Constructs a type by picking all properties from type `Type` where\n properties `Keys` are set to `readonly`, meaning they cannot be reassigned\n- [`MarkRequired`](/lib/mark-required) - Constructs a type by picking all properties from type `Type` where\n properties `Keys` are set as required\n- [`MarkWritable`](/lib/mark-writable) - Constructs a type by picking all properties from type `Type` where\n properties `Keys` remove `readonly` modifier, meaning they can be reassigned\n\n### Deep wrapper types\n\n- [`Buildable`](/lib/buildable) - Constructs a type by combining `DeepPartial` and `DeepWritable`, meaning all\n properties from type `Type` are recursively set as non-`readonly` and optional, meaning they can be reassigned and\n aren't required\n- [`DeepMarkOptional`](/lib/deep-mark-optional) - Constructs a type by picking all properties from type `Type` where\n properties by paths `KeyPathUnion` are set as optional. To mark properties optional on one level, use [`MarkOptional`](/lib/mark-optional). \n- [`DeepMarkRequired`](/lib/deep-mark-required) - Constructs a type by picking all properties from type `Type` where\n properties by paths `KeyPathUnion` are set as required. To mark properties required on one level, use [`MarkRequired`](/lib/mark-required).\n- [`DeepNonNullable`](/lib/deep-non-nullable) - Constructs a type by picking all properties from type `Type`\n recursively and exclude `null` and `undefined` property values from all of them. To make properties non-nullable on\n one level, use [`NonNullable`](https://www.typescriptlang.org/docs/handbook/utility-types.html#nonnullabletype)\n- [`DeepNullable`](/lib/deep-nullable) - Constructs a type by picking all properties from type `Type` recursively\n and include `null` property values for all of them\n- [`DeepOmit`](/lib/deep-omit) - Constructs a type by picking all properties from type `Type` and removing\n properties which values are `never` or `true` in type `Filter`. If you'd like type `Filter` to be validated against a\n structure of `Type`, please use [`StrictDeepOmit`](./lib/strict-deep-omit/).\n- [`DeepPartial`](/lib/deep-partial) - Constructs a type by picking all properties from type `Type` recursively\n and setting them as optional, meaning they aren't required. To make properties optional on one level, use\n [`Partial`](https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype)\n- [`DeepPick`](/lib/deep-pick) - Constructs a type by picking set of properties, which have property\n values `never` or `true` in type `Filter`, from type `Type`. If you'd like type `Filter` to be validated against a\n structure of `Type`, please use [`StrictDeepPick`](./lib/strict-deep-pick/).\n- [`DeepReadonly`](/lib/deep-readonly) - Constructs a type by picking all properties from type `Type` recursively\n and setting `readonly` modifier, meaning they cannot be reassigned. To make properties `readonly` on one level, use\n [`Readonly`](https://www.typescriptlang.org/docs/handbook/utility-types.html#readonlytype)\n- [`DeepRequired`](/lib/deep-required) - Constructs a type by picking all properties from type `Type` recursively\n and setting as required. To make properties required on one level, use\n [`Required`](https://www.typescriptlang.org/docs/handbook/utility-types.html#requiredtype)\n- [`DeepUndefinable`](/lib/deep-undefinable) - Constructs a type by picking all properties from type `Type`\n recursively and include `undefined` property values for all of them\n- [`DeepWritable`](/lib/deep-writable) - Constructs a type by picking all properties from type `Type` recursively\n and removing `readonly` modifier, meaning they can be reassigned. To make properties writable on one level, use\n `Writable`\n- [`StrictDeepOmit`](/lib/strict-deep-omit) - Constructs a type by picking all properties from type `Type`\n and removing properties which values are `never` or `true` in type `Filter`. The type `Filter` is validated against a\n structure of `Type`.\n- [`StrictDeepPick`](/lib/strict-deep-pick) - Constructs a type by picking set of properties, which have\n property values `never` or `true` in type `Filter`, from type `Type`. The type `Filter` is validated against a\n structure of `Type`.\n\n### Key types\n\n- [`OptionalKeys`](/lib/optional-keys) - Constructs a union type by picking all optional properties of object type\n `Type`\n- [`PickKeys`](/lib/pick-keys) - Constructs a union type by picking all properties of object type `Type`\n which values are assignable to type `Value`\n- [`ReadonlyKeys`](/lib/readonly-keys) - Constructs a union type by picking all `readonly` properties of object\n type `Type`, meaning their values cannot be reassigned\n- [`RequiredKeys`](/lib/required-keys) - Constructs a union type by picking all required properties of object type\n `Type`\n- [`WritableKeys`](/lib/writable-keys) - Constructs a union type by picking all writable properties of object type\n `Type`, meaning their values can be reassigned\n\n### Type checkers\n\n- [`Exact`](/lib/exact) - Returns `Type` when type `Type` and `Shape` are identical. Otherwise returns\n `never`\n- [`IsAny`](/lib/is-any) - Returns `true` when type `Type` is `any`. Otherwise returns `false`\n- [`IsNever`](/lib/is-never) - Returns `true` when type `Type` is `never`. Otherwise returns `false`\n- [`IsUnknown`](/lib/is-unknown) - Returns `true` when type `Type` is `unknown`. Otherwise returns `false`\n- [`IsTuple`](/lib/is-tuple) - Returns `Type` when type `Type` is tuple. Otherwise returns `never`\n- [`NonEmptyObject
![\"ts-essentials\"](\"/logo.png\"){kind=logo}
\n ![\"Version\"](\"https://img.shields.io/npm/v/ts-essentials.svg\")
\n \n ![\"Downloads\"](\"https://img.shields.io/npm/dm/ts-essentials.svg\")
\n \n ![\"Build](\"https://github.com/ts-essentials/ts-essentials/actions/workflows/ci.yml/badge.svg\"){kind=icon}
\n \n \n ![\"Telegram\"](\"https://img.shields.io/badge/-telegram-red?color=white&logo=telegram\"){kind=icon}
![\"Software](\"https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square\"){kind=icon}
\n ![\"codechecks.io\"](\"https://raw.githubusercontent.com/codechecks/docs/master/images/badges/badge-default.svg?sanitize=true\"){kind=icon}
\n