type-fest 2.12.0 → 2.13.0

package/index.d.ts

@@ -7,6 +7,7 @@ export * from './source/observable-like';
 // Utilities
 export {Except} from './source/except';
 export {Mutable} from './source/mutable';
+export {Writable} from './source/writable';
 export {Merge} from './source/merge';
 export {MergeExclusive} from './source/merge-exclusive';
 export {RequireAtLeastOne} from './source/require-at-least-one';
@@ -54,6 +55,8 @@ export {
 	NonNegativeInteger,
 } from './source/numeric';
 export {StringKeyOf} from './source/string-key-of';
+export {Exact} from './source/exact';
+export {ReadonlyTuple} from './source/readonly-tuple';
 
 // Template literal types
 export {CamelCase} from './source/camel-case';
@@ -75,6 +78,7 @@ export {DelimiterCasedPropertiesDeep} from './source/delimiter-cased-properties-
 export {Join} from './source/join';
 export {Split} from './source/split';
 export {Trim} from './source/trim';
+export {Replace} from './source/replace';
 export {Includes} from './source/includes';
 export {Get} from './source/get';
 export {LastArrayElement} from './source/last-array-element';

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "type-fest",
-	"version": "2.12.0",
+	"version": "2.13.0",
 	"description": "A collection of essential TypeScript types",
 	"license": "(MIT OR CC0-1.0)",
 	"repository": "sindresorhus/type-fest",
@@ -33,9 +33,9 @@
 	],
 	"devDependencies": {
 		"@sindresorhus/tsconfig": "~0.7.0",
-		"expect-type": "^0.12.0",
-		"tsd": "^0.17.0",
-		"typescript": ">=4.2",
+		"expect-type": "^0.13.0",
+		"tsd": "^0.20.0",
+		"typescript": "^4.6.3",
 		"xo": "^0.43.0"
 	},
 	"types": "./index.d.ts",

package/readme.md

@@ -9,6 +9,7 @@
 	<br>
 	<br>
 	<br>
+	<hr>
 	<div align="center">
 		<p>
 			<p>
@@ -24,6 +25,7 @@
 			</a>
 			<br>
 			<br>
+			<br>
 			<a href="https://workos.com/?utm_campaign=github_repo&utm_medium=referral&utm_content=type-fest&utm_source=github">
 				<div>
 					<img src="https://sindresorhus.com/assets/thanks/workos-logo-white-bg.svg" width="220" alt="WorkOS">
@@ -35,6 +37,72 @@
 					<sup>Add Single Sign-On (and more) in minutes instead of months.</sup>
 				</div>
 			</a>
+			<br>
+			<br>
+			<br>
+			<a href="https://neverinstall.com/spaces/devtools?utm_source=github&utm_medium=sponsor&utm_campaign=sindre#gh-light-mode-only">
+				<div>
+					<img src="https://sindresorhus.com/assets/thanks/neverinstall-logo-light.svg" width="200" alt="neverinstall">
+				</div>
+				<br>
+				<b>All your favourite IDE's now available on the cloud</b>
+				<div>
+					<sub>
+					Neverinstall gives you an uninterrupted development experience and improved accessibility,
+					<br>
+					allowing you to code faster, better and on-the-go on your favourite IDEs like
+					<br>
+					Android Studio, VS Code, Jupyter and PyCharm using your browser.
+					</sub>
+				</div>
+			</a>
+			<a href="https://neverinstall.com/spaces/devtools?utm_source=github&utm_medium=sponsor&utm_campaign=sindre#gh-dark-mode-only">
+				<div>
+					<img src="https://sindresorhus.com/assets/thanks/neverinstall-logo-dark.svg" width="200" alt="neverinstall">
+				</div>
+				<br>
+				<b>All your favourite IDE's now available on the cloud</b>
+				<div>
+					<sub>
+					Neverinstall gives you an uninterrupted development experience and improved accessibility,
+					<br>
+					allowing you to code faster, better and on-the-go on your favourite IDEs like
+					<br>
+					Android Studio, VS Code, Jupyter and PyCharm using your browser.
+					</sub>
+				</div>
+			</a>
+			<br>
+			<br>
+			<br>
+			<a href="https://www.useanvil.com/?utm_source=sindresorhus#gh-light-mode-only">
+				<div>
+					<img src="https://sindresorhus.com/assets/thanks/anvil-logo-light.svg" width="200" alt="Anvil">
+				</div>
+				<br>
+				<b>Paperwork that makes the data work.</b>
+				<div>
+					<sub>
+					Easy APIs for paperwork. PDF generation, e-signature and embeddable no-code webforms.
+					<br>
+					The easiest way to build paperwork automation into your product.
+					</sub>
+				</div>
+			</a>
+			<a href="https://www.useanvil.com/?utm_source=sindresorhus#gh-dark-mode-only">
+				<div>
+					<img src="https://sindresorhus.com/assets/thanks/anvil-logo-dark.svg" width="200" alt="Anvil">
+				</div>
+				<br>
+				<b>Paperwork that makes the data work.</b>
+				<div>
+					<sub>
+					Easy APIs for paperwork. PDF generation, e-signature and embeddable no-code webforms.
+					<br>
+					The easiest way to build paperwork automation into your product.
+					</sub>
+				</div>
+			</a>
 		</p>
 	</div>
 	<br>
@@ -67,7 +135,7 @@ npm install type-fest
 ## Usage
 
 ```ts
-import {Except} from 'type-fest';
+import type {Except} from 'type-fest';
 
 type Foo = {
 	unicorn: string;
@@ -93,7 +161,7 @@ Click the type names for complete docs.
 ### Utilities
 
 - [`Except`](source/except.d.ts) - Create a type from an object type without certain keys. This is a stricter version of [`Omit`](https://www.typescriptlang.org/docs/handbook/utility-types.html#omittype-keys).
-- [`Mutable`](source/mutable.d.ts) - Create a type that strips `readonly` from all or some of an object's keys. The inverse of `Readonly<T>`.
+- [`Writable`](source/writable.d.ts) - Create a type that strips `readonly` from all or some of an object's keys. The inverse of `Readonly<T>`. Formerly named `Mutable`.
 - [`Merge`](source/merge.d.ts) - Merge two types into a new type. Keys of the second type overrides keys of the first type.
 - [`MergeExclusive`](source/merge-exclusive.d.ts) - Create a type that has mutually exclusive keys.
 - [`RequireAtLeastOne`](source/require-at-least-one.d.ts) - Create a type that requires at least one of the given keys.
@@ -122,6 +190,7 @@ Click the type names for complete docs.
 - [`Get`](source/get.d.ts) - Get a deeply-nested property from an object using a key path, like [Lodash's `.get()`](https://lodash.com/docs/latest#get) function.
 - [`StringKeyOf`](source/string-key-of.d.ts) - Get keys of the given type as strings.
 - [`Schema`](source/schema.d.ts) - Create a deep version of another object type where property values are recursively replaced into a given value type.
+- [`Exact`](source/exact.d.ts) - Create a type that does not allow extra properties.
 
 ### JSON
 
@@ -141,6 +210,7 @@ Click the type names for complete docs.
 
 - [`Trim`](source/trim.d.ts) - Remove leading and trailing spaces from a string.
 - [`Split`](source/split.d.ts) - Represents an array of strings split using a given character or character set.
+- [`Replace`](source/replace.d.ts) - Represents a string with some or all matches replaced by a replacement.
 
 ### Array
 
@@ -150,6 +220,7 @@ Click the type names for complete docs.
 - [`FixedLengthArray`](source/fixed-length-array.d.ts) - Create a type that represents an array of the given type and length.
 - [`MultidimensionalArray`](source/multidimensional-array.d.ts) - Create a type that represents a multidimensional array of the given type and dimensions.
 - [`MultidimensionalReadonlyArray`](source/multidimensional-readonly-array.d.ts) - Create a type that represents a multidimensional readonly array of the given type and dimensions.
+- [`ReadonlyTuple`](source/readonly-tuple.d.ts) - Create a type that represents a read-only tuple of the given type and length.
 
 ### Numeric
 
@@ -185,7 +256,7 @@ Click the type names for complete docs.
 
 ### Miscellaneous
 
-- [`PackageJson`](source/package-json.d.ts) - Type for [npm's `package.json` file](https://docs.npmjs.com/creating-a-package-json-file).
+- [`PackageJson`](source/package-json.d.ts) - Type for [npm's `package.json` file](https://docs.npmjs.com/creating-a-package-json-file). It also includes support for [TypeScript Declaration Files](https://www.typescriptlang.org/docs/handbook/declaration-files/publishing.html) and [Yarn Workspaces](https://classic.yarnpkg.com/lang/en/docs/workspaces/).
 - [`TsConfigJson`](source/tsconfig-json.d.ts) - Type for [TypeScript's `tsconfig.json` file](https://www.typescriptlang.org/docs/handbook/tsconfig-json.html) (TypeScript 4.4).
 
 ## Declined types
@@ -199,6 +270,7 @@ Click the type names for complete docs.
 - [`Nullish`](https://github.com/sindresorhus/type-fest/pull/318) - The type only saves a couple of characters, not everyone knows what "nullish" means, and I'm also trying to [get away from `null`](https://github.com/sindresorhus/meta/discussions/7).
 - [`TitleCase`](https://github.com/sindresorhus/type-fest/pull/303) - It's not solving a common need and is a better fit for a separate package.
 - [`ExtendOr` and `ExtendAnd`](https://github.com/sindresorhus/type-fest/pull/247) - The benefits don't outweigh having to learn what they mean.
+- [`PackageJsonExtras`](https://github.com/sindresorhus/type-fest/issues/371) - 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
 
@@ -209,9 +281,28 @@ Click the type names for complete docs.
 
 ## Tips
 
+### Extending existing types
+
+- [`PackageJson`](source/package-json.d.ts) - There are a lot of tools that place extra configurations inside the `package.json` file. You can extend `PackageJson` to support these additional configurations.
+	<details>
+	<summary>
+			Example
+	</summary>
+
+	[Playground](https://www.typescriptlang.org/play?#code/JYWwDg9gTgLgBDAnmApnA3gBQIYGMDW2A5igFIDOEAdnNuXAEJ0o4HFmVUC+cAZlBBBwA5ElQBaXinIxhAbgCwAKFCRYCZGnQAZYFRgooPfoJHSANntmKlysWlaESFanAC8jZo-YuaAMgwLKwBhal5gIgB+AC44XX1DADpQqnCiLhsgA)
+
+	```ts
+	import type {PackageJson as BasePackageJson} from 'type-fest';
+	import type {Linter} from 'eslint';
+
+	type PackageJson = BasePackageJson & {eslintConfig?: Linter.Config};
+	```
+	</details>
+
 ### Related
 
 - [typed-query-selector](https://github.com/g-plane/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`](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/types/eslint/index.d.ts) - Definitions for the [ESLint configuration schema](https://eslint.org/docs/user-guide/configuring/language-options).
 
 ### Built-in types
 

package/source/async-return-type.d.ts

@@ -1,4 +1,4 @@
-import {PromiseValue} from './promise-value';
+import type {PromiseValue} from './promise-value';
 
 type AsyncFunction = (...args: any[]) => Promise<unknown>;
 
@@ -9,7 +9,7 @@ There has been [discussion](https://github.com/microsoft/TypeScript/pull/35998)
 
 @example
 ```ts
-import {AsyncReturnType} from 'type-fest';
+import type {AsyncReturnType} from 'type-fest';
 import {asyncFunction} from 'api';
 
 // This type resolves to the unwrapped return type of `asyncFunction`.

package/source/asyncify.d.ts

@@ -1,5 +1,5 @@
-import {PromiseValue} from './promise-value';
-import {SetReturnType} from './set-return-type';
+import type {PromiseValue} from './promise-value';
+import type {SetReturnType} from './set-return-type';
 
 /**
 Create an async version of the given function type, by boxing the return type in `Promise` while keeping the same parameter types.
@@ -8,7 +8,7 @@ Use-case: You have two functions, one synchronous and one asynchronous that do t
 
 @example
 ```
-import {Asyncify} from 'type-fest';
+import type {Asyncify} from 'type-fest';
 
 // Synchronous function.
 function getFooSync(someArg: SomeType): Foo {

package/source/camel-case.d.ts

@@ -1,5 +1,5 @@
-import {WordSeparators} from '../source/utilities';
-import {Split} from './split';
+import type {WordSeparators} from '../source/utilities';
+import type {Split} from './split';
 
 /**
 Step by step takes the first item in an array literal, formats it and adds it to a string literal, and then recursively appends the remainder.
@@ -36,7 +36,7 @@ This can be useful when, for example, converting some kebab-cased command-line f
 
 @example
 ```
-import {CamelCase} from 'type-fest';
+import type {CamelCase} from 'type-fest';
 
 // Simple
 

package/source/camel-cased-properties-deep.d.ts

@@ -1,4 +1,4 @@
-import {CamelCase} from './camel-case';
+import type {CamelCase} from './camel-case';
 
 /**
 Convert object properties to camel case recursively.
@@ -10,6 +10,8 @@ This can be useful when, for example, converting some API types from a different
 
 @example
 ```
+import type {CamelCasedPropertiesDeep} from 'type-fest';
+
 interface User {
 	UserId: number;
 	UserName: string;

package/source/camel-cased-properties.d.ts

@@ -1,4 +1,4 @@
-import {CamelCase} from './camel-case';
+import type {CamelCase} from './camel-case';
 
 /**
 Convert object properties to camel case but not recursively.
@@ -10,6 +10,8 @@ This can be useful when, for example, converting some API types from a different
 
 @example
 ```
+import type {CamelCasedProperties} from 'type-fest';
+
 interface User {
 	UserId: number;
 	UserName: string;

package/source/conditional-except.d.ts

@@ -1,5 +1,5 @@
-import {Except} from './except';
-import {ConditionalKeys} from './conditional-keys';
+import type {Except} from './except';
+import type {ConditionalKeys} from './conditional-keys';
 
 /**
 Exclude keys from a shape that matches the given `Condition`.
@@ -8,7 +8,7 @@ This is useful when you want to create a new type with a specific set of keys fr
 
 @example
 ```
-import {Primitive, ConditionalExcept} from 'type-fest';
+import type {Primitive, ConditionalExcept} from 'type-fest';
 
 class Awesome {
 	name: string;
@@ -24,7 +24,7 @@ type ExceptPrimitivesFromAwesome = ConditionalExcept<Awesome, Primitive>;
 
 @example
 ```
-import {ConditionalExcept} from 'type-fest';
+import type {ConditionalExcept} from 'type-fest';
 
 interface Example {
 	a: string;

package/source/conditional-keys.d.ts

@@ -5,7 +5,7 @@ Internally this is used for the `ConditionalPick` and `ConditionalExcept` types.
 
 @example
 ```
-import {ConditionalKeys} from 'type-fest';
+import type {ConditionalKeys} from 'type-fest';
 
 interface Example {
 	a: string;
@@ -22,6 +22,8 @@ To support partial types, make sure your `Condition` is a union of undefined (fo
 
 @example
 ```
+import type {ConditionalKeys} from 'type-fest';
+
 type StringKeysAndUndefined = ConditionalKeys<Example, string | undefined>;
 //=> 'a' | 'c'
 ```

package/source/conditional-pick.d.ts

@@ -1,4 +1,4 @@
-import {ConditionalKeys} from './conditional-keys';
+import type {ConditionalKeys} from './conditional-keys';
 
 /**
 Pick keys from the shape that matches the given `Condition`.
@@ -7,7 +7,7 @@ This is useful when you want to create a new type from a specific subset of an e
 
 @example
 ```
-import {Primitive, ConditionalPick} from 'type-fest';
+import type {Primitive, ConditionalPick} from 'type-fest';
 
 class Awesome {
 	name: string;
@@ -23,7 +23,7 @@ type PickPrimitivesFromAwesome = ConditionalPick<Awesome, Primitive>;
 
 @example
 ```
-import {ConditionalPick} from 'type-fest';
+import type {ConditionalPick} from 'type-fest';
 
 interface Example {
 	a: string;

package/source/delimiter-case.d.ts

@@ -1,4 +1,4 @@
-import {UpperCaseCharacters, WordSeparators} from '../source/utilities';
+import type {UpperCaseCharacters, WordSeparators} from '../source/utilities';
 
 /**
 Unlike a simpler split, this one includes the delimiter splitted on in the resulting array literal. This is to enable splitting on, for example, upper-case characters.
@@ -54,7 +54,7 @@ This can be useful when, for example, converting a camel-cased object property t
 
 @example
 ```
-import {DelimiterCase} from 'type-fest';
+import type {DelimiterCase} from 'type-fest';
 
 // Simple
 

package/source/delimiter-cased-properties-deep.d.ts

@@ -1,4 +1,4 @@
-import {DelimiterCase} from './delimiter-case';
+import type {DelimiterCase} from './delimiter-case';
 
 /**
 Convert object properties to delimiter case recursively.
@@ -10,6 +10,8 @@ This can be useful when, for example, converting some API types from a different
 
 @example
 ```
+import type {DelimiterCasedPropertiesDeep} from 'type-fest';
+
 interface User {
 	userId: number;
 	userName: string;

package/source/delimiter-cased-properties.d.ts

@@ -1,4 +1,4 @@
-import {DelimiterCase} from './delimiter-case';
+import type {DelimiterCase} from './delimiter-case';
 
 /**
 Convert object properties to delimiter case but not recursively.
@@ -10,6 +10,8 @@ This can be useful when, for example, converting some API types from a different
 
 @example
 ```
+import type {DelimiterCasedProperties} from 'type-fest';
+
 interface User {
 	userId: number;
 	userName: string;

package/source/entries.d.ts

@@ -1,4 +1,4 @@
-import {ArrayEntry, MapEntry, ObjectEntry, SetEntry} from './entry';
+import type {ArrayEntry, MapEntry, ObjectEntry, SetEntry} from './entry';
 
 type ArrayEntries<BaseType extends readonly unknown[]> = Array<ArrayEntry<BaseType>>;
 type MapEntries<BaseType> = Array<MapEntry<BaseType>>;
@@ -14,7 +14,7 @@ For example the {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/R
 
 @example
 ```
-import {Entries} from 'type-fest';
+import type {Entries} from 'type-fest';
 
 interface Example {
 	someKey: number;

package/source/entry.d.ts

@@ -15,7 +15,7 @@ For example the {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/R
 
 @example
 ```
-import {Entry} from 'type-fest';
+import type {Entry} from 'type-fest';
 
 interface Example {
 	someKey: number;

package/source/exact.d.ts

@@ -0,0 +1,51 @@
+import type {Primitive} from './primitive';
+import type {KeysOfUnion} from './internal';
+
+/**
+Create a type that does not allow extra properties, meaning it only allows properties that are explicitly declared.
+
+This is useful for function type-guarding to reject arguments with excess properties. Due to the nature of TypeScript, it does not complain if excess properties are provided unless the provided value is an object literal.
+
+*Please upvote [this issue](https://github.com/microsoft/TypeScript/issues/12936) if you want to have this type as a built-in in TypeScript.*
+
+@example
+```
+type OnlyAcceptName = {name: string};
+
+function onlyAcceptName(args: OnlyAcceptName) {}
+
+// TypeScript complains about excess properties when an object literal is provided.
+onlyAcceptName({name: 'name', id: 1});
+//=> `id` is excess
+
+// TypeScript does not complain about excess properties when the provided value is a variable (not an object literal).
+const invalidInput = {name: 'name', id: 1};
+onlyAcceptName(invalidInput); // No errors
+```
+
+Having `Exact` allows TypeScript to reject excess properties.
+
+@example
+```
+import {Exact} from 'type-fest';
+
+type OnlyAcceptName = {name: string};
+
+function onlyAcceptNameImproved<T extends Exact<OnlyAcceptName, T>>(args: T) {}
+
+const invalidInput = {name: 'name', id: 1};
+onlyAcceptNameImproved(invalidInput); // Compilation error
+```
+
+[Read more](https://stackoverflow.com/questions/49580725/is-it-possible-to-restrict-typescript-object-to-contain-only-properties-defined)
+
+@category Utilities
+*/
+export type Exact<ParameterType, InputType extends ParameterType> = ParameterType extends Primitive
+	? ParameterType
+	/*
+	Create a type from `ParameterType` and `InputType` and change keys exclusive to `InputType` to `never`.
+	- Generate a list of keys that exists in `InputType` but not in `ParameterType`.
+	- Mark these excess keys as `never`.
+	*/
+	: {[Key in keyof ParameterType]: Exact<ParameterType[Key], InputType[Key]>} & Record<Exclude<keyof InputType, KeysOfUnion<ParameterType>>, never>;

package/source/except.d.ts

@@ -1,4 +1,4 @@
-import {IsEqual} from './internal';
+import type {IsEqual} from './internal';
 
 /**
 Filter out keys from an object.
@@ -38,7 +38,7 @@ This type was proposed to the TypeScript team, which declined it, saying they pr
 
 @example
 ```
-import {Except} from 'type-fest';
+import type {Except} from 'type-fest';
 
 type Foo = {
 	a: number;

package/source/fixed-length-array.d.ts

@@ -13,9 +13,11 @@ Use-cases:
 - Creating a range union (for example, `0 | 1 | 2 | 3 | 4` from the keys of such a type) without having to resort to recursive types.
 - Creating an array of coordinates with a static length, for example, length of 3 for a 3D vector.
 
+Note: This type does not prevent out-of-bounds access. Prefer `ReadonlyTuple` unless you need mutability.
+
 @example
 ```
-import {FixedLengthArray} from 'type-fest';
+import type {FixedLengthArray} from 'type-fest';
 
 type FencingTeam = FixedLengthArray<string, 3>;
 
@@ -29,6 +31,7 @@ guestFencingTeam.push('Sam');
 ```
 
 @category Array
+@see ReadonlyTuple
 */
 export type FixedLengthArray<Element, Length extends number, ArrayPrototype = [Element, ...Element[]]> = Pick<
 	ArrayPrototype,

package/source/get.d.ts

@@ -1,6 +1,6 @@
-import {StringDigit} from '../source/utilities';
-import {Split} from './split';
-import {StringKeyOf} from './string-key-of';
+import type {StringDigit} from '../source/utilities';
+import type {Split} from './split';
+import type {StringKeyOf} from './string-key-of';
 
 type GetOptions = {
 	strict?: boolean;
@@ -97,10 +97,15 @@ type WithStringsKeys = keyof WithStrings;
 //=> 'foo' | '0'
 ```
 */
-type WithStringKeys<BaseType extends Record<string | number, any>> = {
-	[Key in StringKeyOf<BaseType>]: BaseType[Key]
+type WithStringKeys<BaseType> = {
+	[Key in StringKeyOf<BaseType>]: UncheckedIndex<BaseType, Key>
 };
 
+/**
+Perform a `T[U]` operation if `T` supports indexing.
+*/
+type UncheckedIndex<T, U extends string | number> = [T] extends [Record<string | number, any>] ? T[U] : never;
+
 /**
 Get a property of an object or array. Works when indexing arrays using number-literal-strings, for example, `PropertyOf<number[], '0'> = number`, and when indexing objects with number keys.
 
@@ -136,7 +141,7 @@ Use-case: Retrieve a property from deep inside an API response or some other com
 
 @example
 ```
-import {Get} from 'type-fest';
+import type {Get} from 'type-fest';
 import * as lodash from 'lodash';
 
 const get = <BaseType, Path extends string | readonly string[]>(object: BaseType, path: Path): Get<BaseType, Path> =>

package/source/includes.d.ts

@@ -1,4 +1,4 @@
-import {IsEqual} from './internal';
+import type {IsEqual} from './internal';
 
 /**
 Returns a boolean for whether the given array includes the given item.
@@ -7,7 +7,7 @@ This can be useful if another type wants to make a decision based on whether the
 
 @example
 ```
-import {Includes} from 'type-fest';
+import type {Includes} from 'type-fest';
 
 type hasRed<array extends any[]> = Includes<array, 'red'>;
 ```

package/source/internal.d.ts

@@ -1,4 +1,4 @@
-import {Primitive} from './primitive';
+import type {Primitive} from './primitive';
 
 /**
 Returns a boolean for whether the two given types are equal.
@@ -42,3 +42,12 @@ export type Subtract<A extends number, B extends number> = BuildTuple<A> extends
 Matches any primitive, `Date`, or `RegExp` value.
 */
 export type BuiltIns = Primitive | Date | RegExp;
+
+/**
+Gets keys from a type. Similar to `keyof` but this one also works for union types.
+
+The reason a simple `keyof Union` does not work is because `keyof` always returns the accessible keys of a type. In the case of a union, that will only be the common keys.
+
+@link https://stackoverflow.com/a/49402091
+*/
+export type KeysOfUnion<T> = T extends T ? keyof T : never;

package/source/invariant-of.d.ts

@@ -1,4 +1,4 @@
-import {Opaque} from './opaque';
+import type {Opaque} from './opaque';
 
 /**
 Create an [invariant type](https://basarat.gitbook.io/typescript/type-system/type-compatibility#footnote-invariance), which is a type that does not accept supertypes and subtypes.
@@ -9,6 +9,8 @@ Use-case:
 
 @example
 ```
+import type {InvariantOf} from 'type-fest';
+
 class Animal {
 	constructor(public name: string){}
 }
@@ -32,6 +34,8 @@ invariantAnimalArray = invariantCatArray; // Error: Type 'InvariantOf<Cat>[]' is
 
 @example
 ```
+import type {InvariantOf} from 'type-fest';
+
 // In covariance (default)
 
 interface FooBar {

package/source/iterable-element.d.ts

@@ -9,6 +9,8 @@ Here is an example of `IterableElement` in action with a generator function:
 
 @example
 ```
+import type {IterableElement} from 'type-fest';
+
 function * iAmGenerator() {
 	yield 1;
 	yield 2;
@@ -21,6 +23,8 @@ And here is an example with an async generator:
 
 @example
 ```
+import type {IterableElement} from 'type-fest';
+
 async function * iAmGeneratorAsync() {
 	yield 'hi';
 	yield true;
@@ -35,6 +39,8 @@ An example with an array of strings:
 
 @example
 ```
+import type {IterableElement} from 'type-fest';
+
 type MeString = IterableElement<string[]>
 ```
 

package/source/join.d.ts

@@ -5,7 +5,7 @@ Use-case: Defining key paths in a nested object. For example, for dot-notation f
 
 @example
 ```
-import {Join} from 'type-fest';
+import type {Join} from 'type-fest';
 
 // Mixed (strings & numbers) items; result is: 'foo.0.baz'
 const path: Join<['foo', 0, 'baz'], '.'> = ['foo', 0, 'baz'].join('.');