type-fest

A collection of essential TypeScript types

---

^{Sindre Sorhus' open source work is supported by the community}

^{Special thanks to:}

Effortless backends with infrastructure from code

^{An open-source framework that supports any programming language, cloud provider, or deployment automation tool.}

---


Many of the types here should have been built-in. You can help by suggesting some of them to the TypeScript project.

Either add this package as a dependency or copy-paste the needed types. No credit required. 👌

PR welcome for additional commonly needed types and docs improvements. Read the contributing guidelines first.

Help wanted with reviewing proposals and pull requests.

Install

``sh
npm install type-fest
`

Requires TypeScript >=5.9, ESM, and {strict: true} in your tsconfig.

> [!NOTE]
> This readme shows the current development version. For docs about the latest version, see the npm page.

You may also like my ts-extras package which provides runtime functions for some of these types.

Usage

`ts
import type {Except} from 'type-fest';

type Foo = {
unicorn: string;
rainbow: boolean;
};

type FooWithoutRainbow = Except;
//=> {unicorn: string}
`

API

Click the type names for complete docs.

$3

- Primitive - Matches any primitive value.
- Class - Matches a class.
- Constructor - Matches a class constructor.
- AbstractClass - Matches an abstract class.
- AbstractConstructor - Matches an abstract class constructor.
- TypedArray - Matches any typed array, like Uint8Array or Float64Array.
- ObservableLike - Matches a value that is like an Observable.
- LowercaseLetter - Matches any lowercase letter in the basic Latin alphabet (a-z).
- UppercaseLetter - Matches any uppercase letter in the basic Latin alphabet (A-Z).
- DigitCharacter - Matches any digit as a string ('0'-'9').
- Alphanumeric - Matches any lowercase letter (a-z), uppercase letter (A-Z), or digit ('0'-'9') in the basic Latin alphabet.

$3

- EmptyObject - Represents a strictly empty plain object, the {} value.
- NonEmptyObject - Represents an object with at least 1 non-optional key.
- UnknownRecord - Represents an object with unknown value. You probably want this instead of {}.
- UnknownArray - Represents an array with unknown value.
- UnknownMap - Represents a map with unknown key and value.
- UnknownSet - Represents a set with unknown value.
- Except - Create a type from an object type without certain keys. This is a stricter version of Omit.
- Writable - Create a type that strips readonly from the given type. Inverse of Readonly.
- WritableDeep - Create a deeply mutable version of an object/ReadonlyMap/ReadonlySet/ReadonlyArray type. The inverse of ReadonlyDeep. Use Writable if you only need one level deep.
- Merge - Merge two types into a new type. Keys of the second type overrides keys of the first type.
- ObjectMerge - Merge two object types into a new object type, where keys from the second override keys from the first.
- MergeDeep - Merge two objects or two arrays/tuples recursively into a new type.
- MergeExclusive - Create a type that has mutually exclusive keys.
- OverrideProperties - Override only existing properties of the given type. Similar to Merge, but enforces that the original type has the properties you want to override.
- RequireAtLeastOne - Create a type that requires at least one of the given keys.
- RequireExactlyOne - Create a type that requires exactly a single key of the given keys and disallows more.
- RequireAllOrNone - Create a type that requires all of the given keys or none of the given keys.
- RequireOneOrNone - Create a type that requires exactly a single key of the given keys and disallows more, or none of the given keys.
- SingleKeyObject - Create a type that only accepts an object with a single key.
- RequiredDeep - Create a deeply required version of another type. Use Required if you only need one level deep.
- PickDeep - Pick properties from a deeply-nested object. Use Pick if you only need one level deep.
- OmitDeep - Omit properties from a deeply-nested object. Use Omit if you only need one level deep.
- OmitIndexSignature - Omit any index signatures from the given object type, leaving only explicitly defined properties.
- PickIndexSignature - Pick only index signatures from the given object type, leaving out all explicitly defined properties.
- PartialDeep - Create a deeply optional version of another type. Use Partial if you only need one level deep.
- PartialOnUndefinedDeep - Create a deep version of another type where all keys accepting undefined type are set to optional.
- UndefinedOnPartialDeep - Create a deep version of another type where all optional keys are set to also accept undefined.
- UnwrapPartial - Revert the Partial modifier on an object type.
- ReadonlyDeep - Create a deeply immutable version of an object/Map/Set/Array type. Use Readonly if you only need one level deep.
- LiteralUnion - Create a union type by combining primitive types and literal types without sacrificing auto-completion in IDEs for the literal type part of the union. Workaround for Microsoft/TypeScript#29729.
- Tagged - Create a tagged type that can support multiple tags and per-tag metadata. (This replaces the previous Opaque type, which is now deprecated.)
- UnwrapTagged - Get the untagged portion of a tagged type created with Tagged. (This replaces the previous UnwrapOpaque type, which is now deprecated.)
- InvariantOf - Create an invariant type, which is a type that does not accept supertypes and subtypes.
- SetOptional - Create a type that makes the given keys optional.
- SetReadonly - Create a type that makes the given keys readonly.
- SetRequired - Create a type that makes the given keys required.
- SetRequiredDeep - Like SetRequired except it selects the keys deeply.
- SetNonNullable - Create a type that makes the given keys non-nullable.
- SetNonNullableDeep - Create a type that makes the specified keys non-nullable (removes null and undefined), supports deeply nested key paths, and leaves all other keys unchanged.
- ValueOf - Create a union of the given object's values, and optionally specify which keys to get the values from.
- ConditionalKeys - Extract keys from a shape where values extend the given Condition type.
- ConditionalPick - Like Pick except it selects properties from a shape where the values extend the given Condition type.
- ConditionalPickDeep - Like ConditionalPick except that it selects the properties deeply.
- ConditionalExcept - Like Omit except it removes properties from a shape where the values extend the given Condition type.
- UnionToIntersection - Convert a union type to an intersection type.
- LiteralToPrimitive - Convert a literal type to the primitive type it belongs to.
- LiteralToPrimitiveDeep - Like LiteralToPrimitive except it converts literal types inside an object or array deeply.
- Stringified - Create a type with the keys of the given type changed to string type.
- IterableElement - Get the element type of an Iterable/AsyncIterable. For example, Array, Set, Map, generator, stream, etc.
- Entry - Create a type that represents the type of an entry of a collection.
- Entries - Create a type that represents the type of the entries of a collection.
- SetReturnType - Create a function type with a return type of your choice and the same parameters as the given function type.
- SetParameterType - Create a function that replaces some parameters with the given parameters.
- Simplify - Useful to flatten the type output to improve type hints shown in editors. And also to transform an interface into a type to aide with assignability.
- SimplifyDeep - Deeply simplifies an object type.
- Get - Get a deeply-nested property from an object using a key path, like Lodash's .get() function.
- KeyAsString - Get keys of the given type as strings.
- Schema - Create a deep version of another object type where property values are recursively replaced into a given value type.
- Exact - Create a type that does not allow extra properties.
- KeysOfUnion - Create a union of all keys from a given type, even those exclusive to specific union members.
- OptionalKeysOf - Extract all optional keys from the given type.
- HasOptionalKeys - Create a true/false type depending on whether the given type has any optional fields.
- RequiredKeysOf - Extract all required keys from the given type.
- HasRequiredKeys - Create a true/false type depending on whether the given type has any required fields.
- ReadonlyKeysOf - Extract all readonly keys from the given type.
- HasReadonlyKeys - Create a true/false type depending on whether the given type has any readonly fields.
- WritableKeysOf - Extract all writable (non-readonly) keys from the given type.
- HasWritableKeys - Create a true/false type depending on whether the given type has any writable fields.
- Spread - Mimic the type inferred by TypeScript when merging two objects or two arrays/tuples using the spread syntax.
- IsEqual - Returns a boolean for whether the two given types are equal.
- TaggedUnion - Create a union of types that share a common discriminant property.
- IntRange - Generate a union of numbers (includes the start and excludes the end).
- IntClosedRange - Generate a union of numbers (includes the start and the end).
- ArrayIndices - Provides valid indices for a constant array or tuple.
- ArrayValues - Provides all values for a constant array or tuple.
- ArraySplice - Create a new array type by adding or removing elements at a specified index range in the original array.
- ArrayTail - Extract the type of an array or tuple minus the first element.
- SetFieldType - Create a type that changes the type of the given keys.
- Paths - Generate a union of all possible paths to properties in the given object.
- SharedUnionFields - Create a type with shared fields from a union of object types.
- SharedUnionFieldsDeep - Create a type with shared fields from a union of object types, deeply traversing nested structures.
- AllUnionFields - Create a type with all fields from a union of object types.
- DistributedOmit - Omits keys from a type, distributing the operation over a union.
- DistributedPick - Picks keys from a type, distributing the operation over a union.
- And - Returns a boolean for whether two given types are both true.
- Or - Returns a boolean for whether either of two given types is true.
- Xor - Returns a boolean for whether only one of two given types is true.
- AllExtend - Returns a boolean for whether every element in an array type extends another type.
- NonEmptyTuple - Matches any non-empty tuple.
- NonEmptyString - Matches any non-empty string.
- FindGlobalType - Tries to find the type of a global with the given name.
- FindGlobalInstanceType - Tries to find one or more types from their globally-defined constructors.
- ConditionalSimplify - Simplifies a type while including and/or excluding certain types from being simplified.
- ConditionalSimplifyDeep - Recursively simplifies a type while including and/or excluding certain types from being simplified.
- ExclusifyUnion - Ensure mutual exclusivity in object unions by adding other members’ keys as ?: never.

$3

- If - An if-else-like type that resolves depending on whether the given boolean type is true or false.
- IsLiteral - Returns a boolean for whether the given type is a literal type.
- IsStringLiteral - Returns a boolean for whether the given type is a string literal type.
- IsNumericLiteral - Returns a boolean for whether the given type is a number or bigint literal type.
- IsBooleanLiteral - Returns a boolean for whether the given type is a true or false literal type.
- IsSymbolLiteral - Returns a boolean for whether the given type is a symbol literal type.
- IsAny - Returns a boolean for whether the given type is any.
- IsNever - Returns a boolean for whether the given type is never.
- IsUnknown - Returns a boolean for whether the given type is unknown.
- IsEmptyObject - Returns a boolean for whether the type is strictly equal to an empty plain object, the {} value.
- IsNull - Returns a boolean for whether the given type is null.
- IsUndefined - Returns a boolean for whether the given type is undefined.
- IsTuple - Returns a boolean for whether the given array is a tuple.
- IsUnion - Returns a boolean for whether the given type is a union.
- IsLowercase - Returns a boolean for whether the given string literal is lowercase.
- IsUppercase - Returns a boolean for whether the given string literal is uppercase.
- IsOptional - Returns a boolean for whether the given type includes undefined.
- IsNullable - Returns a boolean for whether the given type includes null.
- IsOptionalKeyOf - Returns a boolean for whether the given key is an optional key of type.
- IsRequiredKeyOf - Returns a boolean for whether the given key is a required key of type.
- IsReadonlyKeyOf - Returns a boolean for whether the given key is a readonly key of type.
- IsWritableKeyOf - Returns a boolean for whether the given key is a writable key of type.

$3

- Jsonify - Transform a type to one that is assignable to the JsonValue type.
- Jsonifiable - Matches a value that can be losslessly converted to JSON.
- JsonPrimitive - Matches a JSON primitive.
- JsonObject - Matches a JSON object.
- JsonArray - Matches a JSON array.
- JsonValue - Matches any valid JSON value.

$3

- StructuredCloneable - Matches a value that can be losslessly cloned using structuredClone.

$3

- Promisable - Create a type that represents either the value or the value wrapped in PromiseLike.
- AsyncReturnType - Unwrap the return type of a function that returns a Promise.
- Asyncify - Create an async version of the given function type.

$3

- Trim - Remove leading and trailing spaces from a string.
- Split - Represents an array of strings split using a given character or character set.
- Words - Represents an array of strings split using a heuristic for detecting words.
- Replace - Represents a string with some or all matches replaced by a replacement.
- StringSlice - Returns a string slice of a given range, just like String#slice().
- StringRepeat - Returns a new string which contains the specified number of copies of a given string, just like String#repeat().
- RemovePrefix - Remove the specified prefix from the start of a string.

$3

- Arrayable - Create a type that represents either the value or an array of the value.
- Includes - Returns a boolean for whether the given array includes the given item.
- Join - Join an array of strings and/or numbers using the given string as a delimiter.
- ArraySlice - Returns an array slice of a given range, just like Array#slice().
- ArrayElement - Extracts the element type of an array or tuple.
- LastArrayElement - Extract the type of the last element of an array.
- FixedLengthArray - Create a type that represents an array of the given type and length. The Array prototype methods that manipulate its length are excluded from the resulting type.
- MultidimensionalArray - Create a type that represents a multidimensional array of the given type and dimensions.
- MultidimensionalReadonlyArray - Create a type that represents a multidimensional readonly array of the given type and dimensions.
- ReadonlyTuple - Create a type that represents a read-only tuple of the given type and length.
- TupleToUnion - Convert a tuple/array into a union type of its elements.
- UnionToTuple - Convert a union type into an unordered tuple type of its elements.
- TupleToObject - Transforms a tuple into an object, mapping each tuple index to its corresponding type as a key-value pair.
- TupleOf - Create a tuple type of the specified length with elements of the specified type.
- SplitOnRestElement - Splits an array into three parts, where the first contains all elements before the rest element, the second is the rest element itself, and the third contains all elements after the rest element.
- ExtractRestElement - Extract the rest element type from an array.
- ExcludeRestElement - Create a tuple with the rest element removed.
- ArrayReverse - Reverse the order of elements in a tuple type.

$3

- PositiveInfinity - Matches the hidden Infinity type.
- NegativeInfinity - Matches the hidden -Infinity type.
- Finite - A finite number.
- Integer - A number that is an integer.
- Float - A number that is not an integer.
- NegativeFloat - A negative (-∞ < x < 0) number that is not an integer.
- Negative - A negative number/bigint (-∞ < x < 0)
- NonNegative - A non-negative number/bigint (0 <= x < ∞).
- NegativeInteger - A negative (-∞ < x < 0) number that is an integer.
- NonNegativeInteger - A non-negative (0 <= x < ∞) number that is an integer.
- IsNegative - Returns a boolean for whether the given number is a negative number.
- IsFloat - Returns a boolean for whether the given number is a float, like 1.5 or -1.5.
- IsInteger - Returns a boolean for whether the given number is a integer, like -5, 1.0 or 100.
- GreaterThan - Returns a boolean for whether a given number is greater than another number.
- GreaterThanOrEqual - Returns a boolean for whether a given number is greater than or equal to another number.
- LessThan - Returns a boolean for whether a given number is less than another number.
- LessThanOrEqual - Returns a boolean for whether a given number is less than or equal to another number.
- Sum - Returns the sum of two numbers.
- Subtract - Returns the difference between two numbers.

$3

- CamelCase - Convert a string literal to camel-case (fooBar).
- CamelCasedProperties - Convert object properties to camel-case (fooBar).
- CamelCasedPropertiesDeep - Convert object properties to camel-case recursively (fooBar).
- KebabCase - Convert a string literal to kebab-case (foo-bar).
- KebabCasedProperties - Convert object properties to kebab-case (foo-bar).
- KebabCasedPropertiesDeep - Convert object properties to kebab-case recursively (foo-bar).
- PascalCase - Convert a string literal to pascal-case (FooBar).
- PascalCasedProperties - Convert object properties to pascal-case (FooBar).
- PascalCasedPropertiesDeep - Convert object properties to pascal-case recursively (FooBar).
- SnakeCase - Convert a string literal to snake-case (foo_bar).
- SnakeCasedProperties - Convert object properties to snake-case (foo_bar).
- SnakeCasedPropertiesDeep - Convert object properties to snake-case recursively (foo_bar).
- ScreamingSnakeCase - Convert a string literal to screaming-snake-case (FOO_BAR).
- DelimiterCase - Convert a string literal to a custom string delimiter casing.
- DelimiterCasedProperties - Convert object properties to a custom string delimiter casing.
- DelimiterCasedPropertiesDeep - Convert object properties to a custom string delimiter casing recursively.

$3

- GlobalThis - Declare locally scoped properties on globalThis.
- PackageJson - Type for npm's package.json file. It also includes support for TypeScript Declaration Files.
- TsConfigJson - Type for TypeScript's tsconfig.json file.

$3

- ExtendsStrict - A stricter, non-distributive version of extends for checking whether one type is assignable to another.
- ExtractStrict - A stricter version of Extract that ensures every member of U can successfully extract something from T.
- ExcludeStrict - A stricter version of Exclude that ensures every member of U can successfully exclude something from T.

Declined types

If we decline a type addition, we will make sure to document the better solution here.

- Diff and Spread - The pull request author didn't provide any real-world use-cases and the PR went stale. If you think this type is useful, provide some real-world use-cases and we might reconsider.
- Dictionary - You only save a few characters (Dictionary vs Record) from Record, which is more flexible and well-known. Also, you shouldn't use an object as a dictionary. We have Map in JavaScript now.
- ExtractProperties and ExtractMethods - The types violate the single responsibility principle. Instead, refine your types into more granular type hierarchies.
- Url2Json - Inferring search parameters from a URL string is a cute idea, but not very useful in practice, since search parameters are usually dynamic and defined separately.
- Nullish - The type only saves a couple of characters, not everyone knows what "nullish" means, and I'm also trying to get away from null.
- TitleCase - It's not solving a common need and is a better fit for a separate package.
- ExtendOr and ExtendAnd - The benefits don't outweigh having to learn what they mean.
- PackageJsonExtras - There are too many possible configurations that can be put into package.json. If you would like to extend PackageJson to support an additional configuration in your project, please see the Extending existing types section below.

Alternative type names

If you know one of our types by a different name, add it here for discovery.

- Prettify- See Simplify
- Expand- See Simplify
- PartialBy - See SetOptional
- RecordDeep- See Schema
- Mutable- See Writable
- RequireOnlyOne, OneOf - See RequireExactlyOne
- AtMostOne - See RequireOneOrNone
- AllKeys - See KeysOfUnion
- Branded - See Tagged
- Opaque - See Tagged
- SetElement - See IterableElement
- SetEntry - See IterableElement
- SetValues - See IterableElement
- PickByTypes - See ConditionalPick
- HomomorphicOmit - See Except
- IfAny, IfNever, If* - See If
- MaybePromise - See Promisable
- ReadonlyTuple - See TupleOf

Tips

$3

- PackageJson - There are a lot of tools that place extra configurations inside the package.json file. You can extend PackageJson to support these additional configurations.


$3

- typed-query-selector - Enhances document.querySelector and document.querySelectorAll with a template literal type that matches element types returned from an HTML element query selector.
- Linter.Config - Definitions for the ESLint configuration schema.

$3

There are many advanced types most users don't know about.


- Awaited - Extract the type of a value that a Promise resolves to.