type-fest 1.2.1 → 1.4.0

package/base.d.ts

@@ -35,6 +35,7 @@ export {Entry} from './source/entry';
 export {Entries} from './source/entries';
 export {SetReturnType} from './source/set-return-type';
 export {Asyncify} from './source/asyncify';
+export {Simplify} from './source/simplify';
 
 // Miscellaneous
 export {PackageJson} from './source/package-json';

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "type-fest",
-	"version": "1.2.1",
+	"version": "1.4.0",
 	"description": "A collection of essential TypeScript types",
 	"license": "(MIT OR CC0-1.0)",
 	"repository": "sindresorhus/type-fest",

package/readme.md

@@ -60,7 +60,7 @@ PR welcome for additional commonly needed types and docs improvements. Read the
 $ npm install type-fest
 ```
 
-*Requires TypeScript >=3.4*
+*Requires TypeScript >=3.8*
 
 ## Usage
 
@@ -119,6 +119,8 @@ Click the type names for complete docs.
 - [`Entries`](source/entries.d.ts) - Create a type that represents the type of the entries of a collection.
 - [`SetReturnType`](source/set-return-type.d.ts) - Create a function type with a return type of your choice and the same parameters as the given function type.
 - [`Asyncify`](source/asyncify.d.ts) - Create an async version of the given function type.
+- [`Includes`](ts41/includes.ts) - Returns a boolean for whether the given array includes the given item.
+- [`Simplify`](source/simplify.d.ts) - Flatten the type output to improve type hints shown in editors.
 
 ### Template literal types
 
@@ -148,7 +150,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).
-- [`TsConfigJson`](source/tsconfig-json.d.ts) - Type for [TypeScript's `tsconfig.json` file](https://www.typescriptlang.org/docs/handbook/tsconfig-json.html) (TypeScript 3.7).
+- [`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
 

package/source/mutable.d.ts

@@ -16,7 +16,7 @@ type Foo = {
 	readonly c: boolean;
 };
 
-const mutableFoo: Mutable<Foo> = {a: 1, b: ['2']};
+const mutableFoo: Mutable<Foo> = {a: 1, b: ['2'], c: true};
 mutableFoo.a = 3;
 mutableFoo.b[0] = 'new value'; // Will still fail as the value of property "b" is still a readonly type.
 mutableFoo.b = ['something']; // Will work as the "b" property itself is no longer readonly.

package/source/package-json.d.ts

@@ -269,6 +269,11 @@ declare namespace PackageJson {
 		*/
 		types?: string;
 
+		/**
+		Version selection map of TypeScript.
+		*/
+		typesVersions?: Record<string, Record<string, string[]>>;
+
 		/**
 		Location of the bundled TypeScript declaration file. Alias of `types`.
 		*/

package/source/simplify.d.ts

@@ -1,4 +1,24 @@
 /**
 Flatten the type output to improve type hints shown in editors.
+
+@example
+```
+import {Simplify} from 'type-fest';
+
+type PositionProps = {
+	top: number;
+	left: number;
+};
+
+type SizeProps = {
+	width: number;
+	height: number;
+};
+
+// In your editor, hovering over `Props` will show a flattened object with all the properties.
+type Props = Simplify<PositionProps & SizeProps>;
+```
+
+@category Utilities
 */
 export type Simplify<T> = {[KeyType in keyof T]: T[KeyType]};

package/source/tsconfig-json.d.ts

@@ -3,6 +3,8 @@ declare namespace TsConfigJson {
 		export type JSX =
 			| 'preserve'
 			| 'react'
+			| 'react-jsx'
+			| 'react-jsxdev'
 			| 'react-native';
 
 		export type Module =
@@ -12,6 +14,7 @@ declare namespace TsConfigJson {
 			| 'UMD'
 			| 'ES6'
 			| 'ES2015'
+			| 'ES2020'
 			| 'ESNext'
 			| 'None'
 			// Lowercase alternatives
@@ -21,6 +24,7 @@ declare namespace TsConfigJson {
 			| 'umd'
 			| 'es6'
 			| 'es2015'
+			| 'es2020'
 			| 'esnext'
 			| 'none';
 
@@ -41,6 +45,7 @@ declare namespace TsConfigJson {
 			| 'ES2018'
 			| 'ES2019'
 			| 'ES2020'
+			| 'ES2021'
 			| 'ESNext'
 			// Lowercase alternatives
 			| 'es3'
@@ -52,6 +57,7 @@ declare namespace TsConfigJson {
 			| 'es2018'
 			| 'es2019'
 			| 'es2020'
+			| 'es2021'
 			| 'esnext';
 
 		export type Lib =
@@ -77,6 +83,7 @@ declare namespace TsConfigJson {
 			| 'ES2017.String'
 			| 'ES2017.TypedArrays'
 			| 'ES2018'
+			| 'ES2018.AsyncGenerator'
 			| 'ES2018.AsyncIterable'
 			| 'ES2018.Intl'
 			| 'ES2018.Promise'
@@ -87,19 +94,31 @@ declare namespace TsConfigJson {
 			| 'ES2019.String'
 			| 'ES2019.Symbol'
 			| 'ES2020'
+			| 'ES2020.BigInt'
+			| 'ES2020.Promise'
 			| 'ES2020.String'
 			| 'ES2020.Symbol.WellKnown'
+			| 'ES2020.SharedMemory'
+			| 'ES2020.Intl'
+			| 'ES2021'
+			| 'ES2021.Promise'
+			| 'ES2021.String'
+			| 'ES2021.WeakRef'
 			| 'ESNext'
 			| 'ESNext.Array'
 			| 'ESNext.AsyncIterable'
 			| 'ESNext.BigInt'
 			| 'ESNext.Intl'
+			| 'ESNext.Promise'
+			| 'ESNext.String'
 			| 'ESNext.Symbol'
+			| 'ESNext.WeakRef'
 			| 'DOM'
 			| 'DOM.Iterable'
 			| 'ScriptHost'
 			| 'WebWorker'
 			| 'WebWorker.ImportScripts'
+			| 'WebWorker.Iterable'
 			// Lowercase alternatives
 			| 'es5'
 			| 'es6'
@@ -123,6 +142,7 @@ declare namespace TsConfigJson {
 			| 'es2017.string'
 			| 'es2017.typedarrays'
 			| 'es2018'
+			| 'es2018.asyncgenerator'
 			| 'es2018.asynciterable'
 			| 'es2018.intl'
 			| 'es2018.promise'
@@ -133,19 +153,31 @@ declare namespace TsConfigJson {
 			| 'es2019.string'
 			| 'es2019.symbol'
 			| 'es2020'
+			| 'es2020.bigint'
+			| 'es2020.promise'
 			| 'es2020.string'
 			| 'es2020.symbol.wellknown'
+			| 'es2020.sharedmemory'
+			| 'es2020.intl'
+			| 'es2021'
+			| 'es2021.promise'
+			| 'es2021.string'
+			| 'es2021.weakref'
 			| 'esnext'
 			| 'esnext.array'
 			| 'esnext.asynciterable'
 			| 'esnext.bigint'
 			| 'esnext.intl'
+			| 'esnext.promise'
+			| 'esnext.string'
 			| 'esnext.symbol'
+			| 'esnext.weakref'
 			| 'dom'
 			| 'dom.iterable'
 			| 'scripthost'
 			| 'webworker'
-			| 'webworker.importscripts';
+			| 'webworker.importscripts'
+			| 'webworker.iterable';
 
 		export interface Plugin {
 			[key: string]: unknown;
@@ -154,6 +186,35 @@ declare namespace TsConfigJson {
 			*/
 			name?: string;
 		}
+
+		export type ImportsNotUsedAsValues =
+			| 'remove'
+			| 'preserve'
+			| 'error';
+
+		export type FallbackPolling =
+			| 'fixedPollingInterval'
+			| 'priorityPollingInterval'
+			| 'dynamicPriorityPolling'
+			| 'fixedInterval'
+			| 'priorityInterval'
+			| 'dynamicPriority'
+			| 'fixedChunkSize';
+
+		export type WatchDirectory =
+			| 'useFsEvents'
+			| 'fixedPollingInterval'
+			| 'dynamicPriorityPolling'
+			| 'fixedChunkSizePolling';
+
+		export type WatchFile =
+			| 'fixedPollingInterval'
+			| 'priorityPollingInterval'
+			| 'dynamicPriorityPolling'
+			| 'useFsEvents'
+			| 'useFsEventsOnParentDirectory'
+			| 'fixedChunkSizePolling';
+
 	}
 
 	export interface CompilerOptions {
@@ -192,6 +253,24 @@ declare namespace TsConfigJson {
 		*/
 		diagnostics?: boolean;
 
+		/**
+		Reduce the number of projects loaded automatically by TypeScript.
+
+		Requires TypeScript version 4.0 or later.
+
+		@default false
+		*/
+		disableReferencedProjectLoad?: boolean;
+
+		/**
+		Enforces using indexed accessors for keys declared using an indexed type.
+
+		Requires TypeScript version 4.2 or later.
+
+		@default false
+		*/
+		noPropertyAccessFromIndexSignature?: boolean;
+
 		/**
 		Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files.
 
@@ -206,6 +285,15 @@ declare namespace TsConfigJson {
 		*/
 		emitDeclarationOnly?: boolean;
 
+		/**
+		Differentiate between undefined and not present when type checking.
+
+		Requires TypeScript version 4.4 or later.
+
+		@default false
+		*/
+		exactOptionalPropertyTypes?: boolean;
+
 		/**
 		Enable incremental compilation.
 
@@ -237,7 +325,7 @@ declare namespace TsConfigJson {
 		inlineSources?: boolean;
 
 		/**
-		Specify JSX code generation: `'preserve'`, `'react'`, or `'react-native'`.
+		Specify what JSX code is generated.
 
 		@default 'preserve'
 		*/
@@ -250,6 +338,33 @@ declare namespace TsConfigJson {
 		*/
 		reactNamespace?: string;
 
+		/**
+		Specify the JSX factory function to use when targeting React JSX emit, e.g. `React.createElement` or `h`.
+
+		Requires TypeScript version 2.1 or later.
+
+		@default 'React.createElement'
+		*/
+		jsxFactory?: string;
+
+		/**
+		Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'.
+
+		Requires TypeScript version 4.0 or later.
+
+		@default 'React.Fragment'
+		*/
+		jsxFragmentFactory?: string;
+
+		/**
+		Specify module specifier used to import the JSX factory functions when using `jsx: react-jsx*`.
+
+		Requires TypeScript version 4.1 or later.
+
+		@default 'react'
+		*/
+		jsxImportSource?: string;
+
 		/**
 		Print names of files part of the compilation.
 
@@ -269,6 +384,13 @@ declare namespace TsConfigJson {
 		*/
 		module?: CompilerOptions.Module;
 
+		/**
+		Specifies module resolution strategy: 'node' (Node) or 'classic' (TypeScript pre 1.6).
+
+		@default ['AMD', 'System', 'ES6'].includes(module) ? 'classic' : 'node'
+		*/
+		moduleResolution?: 'classic' | 'node';
+
 		/**
 		Specifies the end of line sequence to be used when emitting files: 'crlf' (Windows) or 'lf' (Unix).
 
@@ -461,6 +583,15 @@ declare namespace TsConfigJson {
 		*/
 		target?: CompilerOptions.Target;
 
+		/**
+		Default catch clause variables as `unknown` instead of `any`.
+
+		Requires TypeScript version 4.4 or later.
+
+		@default false
+		*/
+		useUnknownInCatchVariables?: boolean;
+
 		/**
 		Watch input files.
 
@@ -468,6 +599,31 @@ declare namespace TsConfigJson {
 		*/
 		watch?: boolean;
 
+		/**
+		Specify the polling strategy to use when the system runs out of or doesn't support native file watchers.
+
+		Requires TypeScript version 3.8 or later.
+		*/
+		fallbackPolling?: CompilerOptions.FallbackPolling;
+
+		/**
+		Specify the strategy for watching directories under systems that lack recursive file-watching functionality.
+
+		Requires TypeScript version 3.8 or later.
+
+		@default 'useFsEvents'
+		*/
+		watchDirectory?: CompilerOptions.WatchDirectory;
+
+		/**
+		Specify the strategy for watching individual files.
+
+		Requires TypeScript version 3.8 or later.
+
+		@default 'useFsEvents'
+		*/
+		watchFile?: CompilerOptions.WatchFile;
+
 		/**
 		Enables experimental support for ES7 decorators.
 
@@ -482,13 +638,6 @@ declare namespace TsConfigJson {
 		*/
 		emitDecoratorMetadata?: boolean;
 
-		/**
-		Specifies module resolution strategy: 'node' (Node) or 'classic' (TypeScript pre 1.6).
-
-		@default ['AMD', 'System', 'ES6'].includes(module) ? 'classic' : 'node'
-		*/
-		moduleResolution?: 'classic' | 'node';
-
 		/**
 		Do not report errors on unused labels.
 
@@ -503,6 +652,15 @@ declare namespace TsConfigJson {
 		*/
 		noImplicitReturns?: boolean;
 
+		/**
+		Add `undefined` to a type when accessed using an index.
+
+		Requires TypeScript version 4.1 or later.
+
+		@default false
+		*/
+		noUncheckedIndexedAccess?: boolean;
+
 		/**
 		Report errors for fallthrough cases in switch statement.
 
@@ -510,6 +668,13 @@ declare namespace TsConfigJson {
 		*/
 		noFallthroughCasesInSwitch?: boolean;
 
+		/**
+		Ensure overriding members in derived classes are marked with an override modifier.
+
+		@default false
+		*/
+		noImplicitOverride?: boolean;
+
 		/**
 		Do not report errors on unreachable code.
 
@@ -524,6 +689,15 @@ declare namespace TsConfigJson {
 		*/
 		forceConsistentCasingInFileNames?: boolean;
 
+		/**
+		Emit a v8 CPU profile of the compiler run for debugging.
+
+		Requires TypeScript version 3.7 or later.
+
+		@default 'profile.cpuprofile'
+		*/
+		generateCpuProfile?: string;
+
 		/**
 		Base directory to resolve non-relative module names.
 		*/
@@ -646,13 +820,11 @@ declare namespace TsConfigJson {
 		importHelpers?: boolean;
 
 		/**
-		Specify the JSX factory function to use when targeting React JSX emit, e.g. `React.createElement` or `h`.
+		Specify emit/checking behavior for imports that are only used for types.
 
-		Requires TypeScript version 2.1 or later.
-
-		@default 'React.createElement'
+		@default 'remove'
 		*/
-		jsxFactory?: string;
+		importsNotUsedAsValues?: CompilerOptions.ImportsNotUsedAsValues;
 
 		/**
 		Parse in strict mode and emit `'use strict'` for each source file.
@@ -766,6 +938,54 @@ declare namespace TsConfigJson {
 		@default false
 		*/
 		resolveJsonModule?: boolean;
+
+		/**
+		Have recompiles in '--incremental' and '--watch' assume that changes within a file will only affect files directly depending on it.
+
+		Requires TypeScript version 3.8 or later.
+
+		@default false
+		*/
+		assumeChangesOnlyAffectDirectDependencies?: boolean;
+
+		/**
+		Output more detailed compiler performance information after building.
+
+		@default false
+		*/
+		extendedDiagnostics?: boolean;
+
+		/**
+		Print names of files that are part of the compilation and then stop processing.
+
+		@default false
+		*/
+		listFilesOnly?: boolean;
+
+		/**
+		Disable preferring source files instead of declaration files when referencing composite projects.
+
+		@default true if composite, false otherwise
+		*/
+		disableSourceOfProjectReferenceRedirect?: boolean;
+
+		/**
+		Opt a project out of multi-project reference checking when editing.
+
+		Requires TypeScript version 3.8 or later.
+
+		@default false
+		*/
+		disableSolutionSearching?: boolean;
+
+		/**
+		Print names of files which TypeScript sees as a part of your project and the reason they are part of the compilation.
+
+		Requires TypeScript version 4.2 or later.
+
+		@default false
+		*/
+		explainFiles?: boolean;
 	}
 
 	/**

package/ts41/camel-case.d.ts

@@ -52,15 +52,21 @@ interface RawOptions {
 	'dry-run': boolean;
 	'full_family_name': string;
 	foo: number;
+	BAR: string;
+	QUZ_QUX: number;
+	'OTHER-FIELD': boolean;
 }
 
 const dbResult: CamelCasedProperties<ModelProps> = {
 	dryRun: true,
 	fullFamilyName: 'bar.js',
-	foo: 123
+	foo: 123,
+	bar: 'foo',
+	quzQux: 6,
+	otherField: false
 };
 ```
 
 @category Template Literals
 */
-export type CamelCase<K> = K extends string ? K extends Uppercase<K> ? Lowercase<K> : CamelCaseStringArray<Split<K, WordSeparators>> : K;
+export type CamelCase<K> = K extends string ? K extends Uppercase<K> ? CamelCaseStringArray<Split<Lowercase<K>, WordSeparators>> : CamelCaseStringArray<Split<K, WordSeparators>> : K;

package/ts41/get.d.ts

@@ -81,6 +81,8 @@ type PropertyOf<BaseType, Key extends string> =
 	? undefined
 	: Key extends keyof BaseType
 	? BaseType[Key]
+	: BaseType extends [] | [unknown, ...unknown[]]
+	? unknown // It's a tuple, but `Key` did not extend `keyof BaseType`. So the index is out of bounds.
 	: BaseType extends {
 		[n: number]: infer Item;
 		length: number; // Note: This is needed to avoid being too lax with records types using number keys like `{0: string; 1: boolean}`.

package/ts41/includes.d.ts

@@ -0,0 +1,31 @@
+/**
+Returns a boolean for whether given two types are equal.
+
+@link https://github.com/microsoft/TypeScript/issues/27024#issuecomment-421529650
+*/
+type IsEqual<T, U> =
+	(<G>() => G extends T ? 1 : 2) extends
+	(<G>() => G extends U ? 1 : 2)
+		? true
+		: false;
+
+/**
+Returns a boolean for whether the given array includes the given item.
+
+This can be useful if another type wants to make a decision based on whether the array includes that item.
+
+@example
+```
+import {Includes} from 'type-fest';
+
+type hasRed<array extends any[]> = Includes<array, 'red'>;
+```
+
+@category Utilities
+*/
+export type Includes<Value extends any[], Item> =
+	IsEqual<Value[0], Item> extends true
+		? true
+		: Value extends [Value[0], ...infer rest]
+			? Includes<rest, Item>
+			: false;

package/ts41/index.d.ts

@@ -20,5 +20,6 @@ export {DelimiterCasedProperties} from './delimiter-cased-properties';
 export {DelimiterCasedPropertiesDeep} from './delimiter-cased-properties-deep';
 export {Split} from './split';
 export {Trim} from './trim';
+export {Includes} from './includes';
 export {Get} from './get';
 export {LastArrayElement} from './last-array-element';

package/ts41/screaming-snake-case.d.ts

@@ -1,14 +1,6 @@
 import {SplitIncludingDelimiters} from './delimiter-case';
 import {SnakeCase} from './snake-case';
-
-/**
-Returns a boolean for whether the given array includes the given item.
-*/
-type Includes<Value extends any[], Item> = {
-	[P in keyof Value & number as Value[P]]: true;
-}[Item] extends true
-	? true
-	: false;
+import {Includes} from './includes';
 
 /**
 Returns a boolean for whether the string is screaming snake case.

package/ts41/split.d.ts

@@ -18,7 +18,11 @@ array = split(items, ',');
 
 @category Template Literals
 */
-export type Split<S extends string, D extends string> =
-	S extends `${infer T}${D}${infer U}`
-		? [T, ...Split<U, D>]
-		: [S];
+export type Split<
+	S extends string,
+	Delimiter extends string
+> = S extends `${infer Head}${Delimiter}${infer Tail}`
+	? [Head, ...Split<Tail, Delimiter>]
+	: S extends Delimiter
+	? []
+	: [S];