type-fest 3.4.0 → 3.5.0

package/index.d.ts

@@ -74,6 +74,7 @@ export type {RequiredKeysOf} from './source/required-keys-of';
 export type {HasRequiredKeys} from './source/has-required-keys';
 export type {Spread} from './source/spread';
 export type {TupleToUnion} from './source/tuple-to-union';
+export type {IsEqual} from './source/is-equal';
 
 // Template literal types
 export type {CamelCase} from './source/camel-case';

package/package.json

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

package/readme.md

@@ -169,6 +169,7 @@ Click the type names for complete docs.
 - [`RequiredKeysOf`](source/required-keys-of.d.ts) - Extract all required keys from the given type.
 - [`HasRequiredKeys`](source/has-required-keys.d.ts) - Create a `true`/`false` type depending on whether the given type has any required fields.
 - [`Spread`](source/spread.d.ts) - Mimic the type inferred by TypeScript when merging two objects or two arrays/tuples using the spread syntax.
+- [`IsEqual`](source/is-equal.d.ts) - Returns a boolean for whether the two given types are equal.
 
 ### JSON
 
@@ -237,7 +238,7 @@ Click the type names for complete docs.
 ### Miscellaneous
 
 - [`GlobalThis`](source/global-this.d.ts) - Declare locally scoped properties on `globalThis`.
-- [`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/).
+- [`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).
 - [`TsConfigJson`](source/tsconfig-json.d.ts) - Type for [TypeScript's `tsconfig.json` file](https://www.typescriptlang.org/docs/handbook/tsconfig-json.html).
 
 ## Declined types

package/source/camel-case.d.ts

@@ -74,5 +74,7 @@ const dbResult: CamelCasedProperties<RawOptions> = {
 @category Template literal
 */
 export type CamelCase<Type, Options extends CamelCaseOptions = {preserveConsecutiveUppercase: true}> = Type extends string
-	? Uncapitalize<CamelCaseFromArray<SplitWords<Type extends Uppercase<Type> ? Lowercase<Type> : Type>, Options>>
+	? string extends Type
+		? Type
+		: Uncapitalize<CamelCaseFromArray<SplitWords<Type extends Uppercase<Type> ? Lowercase<Type> : Type>, Options>>
 	: Type;

package/source/conditional-pick-deep.d.ts

@@ -1,5 +1,5 @@
 import type {Opaque} from './opaque';
-import type {IsEqual} from './internal';
+import type {IsEqual} from './is-equal';
 import type {ConditionalExcept} from './conditional-except';
 import type {ConditionalSimplifyDeep} from './conditional-simplify';
 

package/source/except.d.ts

@@ -1,4 +1,4 @@
-import type {IsEqual} from './internal';
+import type {IsEqual} from './is-equal';
 
 /**
 Filter out keys from an object.

package/source/includes.d.ts

@@ -1,4 +1,4 @@
-import type {IsEqual} from './internal';
+import type {IsEqual} from './is-equal';
 
 /**
 Returns a boolean for whether the given array includes the given item.

package/source/internal.d.ts

@@ -1,18 +1,6 @@
 import type {Primitive} from './primitive';
 import type {Simplify} from './simplify';
 
-/**
-Returns a boolean for whether the two given types are equal.
-
-@link https://github.com/microsoft/TypeScript/issues/27024#issuecomment-421529650
-@link https://stackoverflow.com/questions/68961864/how-does-the-equals-work-in-typescript/68963796#68963796
-*/
-export type IsEqual<T, U> =
-	(<G>() => G extends T ? 1 : 2) extends
-	(<G>() => G extends U ? 1 : 2)
-		? true
-		: false;
-
 /**
 Infer the length of the given array `<T>`.
 

package/source/is-equal.d.ts

@@ -0,0 +1,30 @@
+/**
+Returns a boolean for whether the two given types are equal.
+
+@link https://github.com/microsoft/TypeScript/issues/27024#issuecomment-421529650
+@link https://stackoverflow.com/questions/68961864/how-does-the-equals-work-in-typescript/68963796#68963796
+
+Use-cases:
+- If you want to make a conditional branch based on the result of a comparison of two types.
+
+@example
+```
+import type {IsEqual} from 'type-fest';
+
+// This type returns a boolean for whether the given array includes the given item.
+// `IsEqual` is used to compare the given array at position 0 and the given item and then return true if they are equal.
+type Includes<Value extends readonly any[], Item> =
+	Value extends readonly [Value[0], ...infer rest]
+		? IsEqual<Value[0], Item> extends true
+			? true
+			: Includes<rest, Item>
+		: false;
+```
+
+@category Utilities
+*/
+export type IsEqual<A, B> =
+	(<G>() => G extends A ? 1 : 2) extends
+	(<G>() => G extends B ? 1 : 2)
+		? true
+		: false;

package/source/join.d.ts

@@ -21,13 +21,13 @@ const path: Join<[1, 2, 3], '.'> = [1, 2, 3].join('.');
 @category Template literal
 */
 export type Join<
-	Strings extends Array<string | number>,
+	Strings extends Readonly<Array<string | number>>,
 	Delimiter extends string,
 > = Strings extends []
 	? ''
 	: Strings extends [string | number]
 		? `${Strings[0]}`
-		: Strings extends [
+		: Strings extends readonly [
 			string | number,
 			...infer Rest extends Array<string | number>,
 		]

package/source/multidimensional-array.d.ts

@@ -1,4 +1,5 @@
-import type {IsEqual, Subtract} from './internal';
+import type {Subtract} from './internal';
+import type {IsEqual} from './is-equal';
 
 type Recursive<T> = Array<Recursive<T>>;
 

package/source/multidimensional-readonly-array.d.ts

@@ -1,4 +1,5 @@
-import type {IsEqual, Subtract} from './internal';
+import type {Subtract} from './internal';
+import type {IsEqual} from './is-equal';
 
 type Recursive<T> = ReadonlyArray<Recursive<T>>;
 

package/source/package-json.d.ts

@@ -294,7 +294,7 @@ declare namespace PackageJson {
 	};
 
 	/**
-	An alternative configuration for Yarn workspaces.
+	An alternative configuration for workspaces.
 	*/
 	export type WorkspaceConfig = {
 		/**
@@ -305,7 +305,8 @@ declare namespace PackageJson {
 		/**
 		Designed to solve the problem of packages which break when their `node_modules` are moved to the root workspace directory - a process known as hoisting. For these packages, both within your workspace, and also some that have been installed via `node_modules`, it is important to have a mechanism for preventing the default Yarn workspace behavior. By adding workspace pattern strings here, Yarn will resume non-workspace behavior for any package which matches the defined patterns.
 
-		[Read more](https://classic.yarnpkg.com/blog/2018/02/15/nohoist/)
+		[Supported](https://classic.yarnpkg.com/blog/2018/02/15/nohoist/) by Yarn.
+		[Not supported](https://github.com/npm/rfcs/issues/287) by npm.
 		*/
 		nohoist?: WorkspacePattern[];
 	};
@@ -322,15 +323,6 @@ declare namespace PackageJson {
 	type WorkspacePattern = string;
 
 	export type YarnConfiguration = {
-		/**
-		Used to configure [Yarn workspaces](https://classic.yarnpkg.com/docs/workspaces/).
-
-		Workspaces allow you to manage multiple packages within the same repository in such a way that you only need to run `yarn install` once to install all of them in a single pass.
-
-		Please note that the top-level `private` property of `package.json` **must** be set to `true` in order to use workspaces.
-		*/
-		workspaces?: WorkspacePattern[] | WorkspaceConfig;
-
 		/**
 		If your package only allows one version of a given dependency, and you’d like to enforce the same behavior as `yarn install --flat` on the command-line, set this to `true`.
 
@@ -624,6 +616,15 @@ declare namespace PackageJson {
 			*/
 			url: string;
 		};
+
+		/**
+		Used to configure [npm workspaces](https://docs.npmjs.com/cli/using-npm/workspaces) / [Yarn workspaces](https://classic.yarnpkg.com/docs/workspaces/).
+
+		Workspaces allow you to manage multiple packages within the same repository in such a way that you only need to run your install command once in order to install all of them in a single pass.
+
+		Please note that the top-level `private` property of `package.json` **must** be set to `true` in order to use workspaces.
+		*/
+		workspaces?: WorkspacePattern[] | WorkspaceConfig;
 	}
 
 	/**

package/source/tsconfig-json.d.ts

@@ -221,6 +221,21 @@ declare namespace TsConfigJson {
 			| 'useFsEventsOnParentDirectory'
 			| 'fixedChunkSizePolling';
 
+		export type ModuleResolution =
+			| 'classic'
+			| 'node'
+			| 'node16'
+			| 'nodenext'
+			// Pascal-cased alternatives
+			| 'Classic'
+			| 'Node'
+			| 'Node16'
+			| 'NodeNext';
+
+		export type ModuleDetection =
+			| 'auto'
+			| 'legacy'
+			| 'force';
 	}
 
 	export type CompilerOptions = {
@@ -247,8 +262,6 @@ declare namespace TsConfigJson {
 
 		/**
 		Specify output directory for generated declaration files.
-
-		Requires TypeScript version 2.0 or later.
 		*/
 		declarationDir?: string;
 
@@ -262,8 +275,6 @@ declare namespace TsConfigJson {
 		/**
 		Reduce the number of projects loaded automatically by TypeScript.
 
-		Requires TypeScript version 4.0 or later.
-
 		@default false
 		*/
 		disableReferencedProjectLoad?: boolean;
@@ -271,8 +282,6 @@ declare namespace TsConfigJson {
 		/**
 		Enforces using indexed accessors for keys declared using an indexed type.
 
-		Requires TypeScript version 4.2 or later.
-
 		@default false
 		*/
 		noPropertyAccessFromIndexSignature?: boolean;
@@ -294,8 +303,6 @@ declare namespace TsConfigJson {
 		/**
 		Differentiate between undefined and not present when type checking.
 
-		Requires TypeScript version 4.4 or later.
-
 		@default false
 		*/
 		exactOptionalPropertyTypes?: boolean;
@@ -347,8 +354,6 @@ declare namespace TsConfigJson {
 		/**
 		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;
@@ -356,8 +361,6 @@ declare namespace TsConfigJson {
 		/**
 		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;
@@ -365,8 +368,6 @@ declare namespace TsConfigJson {
 		/**
 		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;
@@ -395,7 +396,7 @@ declare namespace TsConfigJson {
 
 		@default ['AMD', 'System', 'ES6'].includes(module) ? 'classic' : 'node'
 		*/
-		moduleResolution?: 'classic' | 'node';
+		moduleResolution?: CompilerOptions.ModuleResolution;
 
 		/**
 		Specifies the end of line sequence to be used when emitting files: 'crlf' (Windows) or 'lf' (Unix).
@@ -442,8 +443,6 @@ declare namespace TsConfigJson {
 		/**
 		Report errors on unused locals.
 
-		Requires TypeScript version 2.0 or later.
-
 		@default false
 		*/
 		noUnusedLocals?: boolean;
@@ -451,8 +450,6 @@ declare namespace TsConfigJson {
 		/**
 		Report errors on unused parameters.
 
-		Requires TypeScript version 2.0 or later.
-
 		@default false
 		*/
 		noUnusedParameters?: boolean;
@@ -486,8 +483,6 @@ declare namespace TsConfigJson {
 		/**
 		Skip type checking of declaration files.
 
-		Requires TypeScript version 2.0 or later.
-
 		@default false
 		*/
 		skipLibCheck?: boolean;
@@ -592,8 +587,6 @@ declare namespace TsConfigJson {
 		/**
 		Default catch clause variables as `unknown` instead of `any`.
 
-		Requires TypeScript version 4.4 or later.
-
 		@default false
 		*/
 		useUnknownInCatchVariables?: boolean;
@@ -609,8 +602,6 @@ declare namespace TsConfigJson {
 		/**
 		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.
-
 		@deprecated Use watchOptions.fallbackPolling instead.
 		*/
 		fallbackPolling?: CompilerOptions.FallbackPolling;
@@ -618,8 +609,6 @@ declare namespace TsConfigJson {
 		/**
 		Specify the strategy for watching directories under systems that lack recursive file-watching functionality.
 
-		Requires TypeScript version 3.8 or later.
-
 		@default 'useFsEvents'
 		@deprecated Use watchOptions.watchDirectory instead.
 		*/
@@ -628,8 +617,6 @@ declare namespace TsConfigJson {
 		/**
 		Specify the strategy for watching individual files.
 
-		Requires TypeScript version 3.8 or later.
-
 		@default 'useFsEvents'
 		@deprecated Use watchOptions.watchFile instead.
 		*/
@@ -666,8 +653,6 @@ declare namespace TsConfigJson {
 		/**
 		Add `undefined` to a type when accessed using an index.
 
-		Requires TypeScript version 4.1 or later.
-
 		@default false
 		*/
 		noUncheckedIndexedAccess?: boolean;
@@ -703,8 +688,6 @@ declare namespace TsConfigJson {
 		/**
 		Emit a v8 CPU profile of the compiler run for debugging.
 
-		Requires TypeScript version 3.7 or later.
-
 		@default 'profile.cpuprofile'
 		*/
 		generateCpuProfile?: string;
@@ -721,8 +704,6 @@ declare namespace TsConfigJson {
 
 		/**
 		List of TypeScript language server plugins to load.
-
-		Requires TypeScript version 2.3 or later.
 		*/
 		plugins?: CompilerOptions.Plugin[];
 
@@ -733,15 +714,11 @@ declare namespace TsConfigJson {
 
 		/**
 		Specify list of directories for type definition files to be included.
-
-		Requires TypeScript version 2.0 or later.
 		*/
 		typeRoots?: string[];
 
 		/**
 		Type declaration files to be included in compilation.
-
-		Requires TypeScript version 2.0 or later.
 		*/
 		types?: string[];
 
@@ -783,8 +760,6 @@ declare namespace TsConfigJson {
 		/**
 		Enable to list all emitted files.
 
-		Requires TypeScript version 2.0 or later.
-
 		@default false
 		*/
 		listEmittedFiles?: boolean;
@@ -792,24 +767,18 @@ declare namespace TsConfigJson {
 		/**
 		Disable size limit for JavaScript project.
 
-		Requires TypeScript version 2.0 or later.
-
 		@default false
 		*/
 		disableSizeLimit?: boolean;
 
 		/**
 		List of library files to be included in the compilation.
-
-		Requires TypeScript version 2.0 or later.
 		*/
 		lib?: CompilerOptions.Lib[];
 
 		/**
 		Enable strict null checks.
 
-		Requires TypeScript version 2.0 or later.
-
 		@default false
 		*/
 		strictNullChecks?: boolean;
@@ -824,8 +793,6 @@ declare namespace TsConfigJson {
 		/**
 		Import emit helpers (e.g. `__extends`, `__rest`, etc..) from tslib.
 
-		Requires TypeScript version 2.1 or later.
-
 		@default false
 		*/
 		importHelpers?: boolean;
@@ -840,8 +807,6 @@ declare namespace TsConfigJson {
 		/**
 		Parse in strict mode and emit `'use strict'` for each source file.
 
-		Requires TypeScript version 2.1 or later.
-
 		@default false
 		*/
 		alwaysStrict?: boolean;
@@ -849,8 +814,6 @@ declare namespace TsConfigJson {
 		/**
 		Enable all strict type checking options.
 
-		Requires TypeScript version 2.3 or later.
-
 		@default false
 		*/
 		strict?: boolean;
@@ -865,8 +828,6 @@ declare namespace TsConfigJson {
 		/**
 		Provide full support for iterables in `for-of`, spread, and destructuring when targeting `ES5` or `ES3`.
 
-		Requires TypeScript version 2.3 or later.
-
 		@default false
 		*/
 		downlevelIteration?: boolean;
@@ -874,8 +835,6 @@ declare namespace TsConfigJson {
 		/**
 		Report errors in `.js` files.
 
-		Requires TypeScript version 2.3 or later.
-
 		@default false
 		*/
 		checkJs?: boolean;
@@ -883,8 +842,6 @@ declare namespace TsConfigJson {
 		/**
 		Disable bivariant parameter checking for function types.
 
-		Requires TypeScript version 2.6 or later.
-
 		@default false
 		*/
 		strictFunctionTypes?: boolean;
@@ -892,8 +849,6 @@ declare namespace TsConfigJson {
 		/**
 		Ensure non-undefined class properties are initialized in the constructor.
 
-		Requires TypeScript version 2.7 or later.
-
 		@default false
 		*/
 		strictPropertyInitialization?: boolean;
@@ -901,8 +856,6 @@ declare namespace TsConfigJson {
 		/**
 		Emit `__importStar` and `__importDefault` helpers for runtime Babel ecosystem compatibility and enable `--allowSyntheticDefaultImports` for typesystem compatibility.
 
-		Requires TypeScript version 2.7 or later.
-
 		@default false
 		*/
 		esModuleInterop?: boolean;
@@ -917,8 +870,6 @@ declare namespace TsConfigJson {
 		/**
 		Resolve `keyof` to string valued property names only (no numbers or symbols).
 
-		Requires TypeScript version 2.9 or later.
-
 		@default false
 		*/
 		keyofStringsOnly?: boolean;
@@ -926,8 +877,6 @@ declare namespace TsConfigJson {
 		/**
 		Emit ECMAScript standard class fields.
 
-		Requires TypeScript version 3.7 or later.
-
 		@default false
 		*/
 		useDefineForClassFields?: boolean;
@@ -935,8 +884,6 @@ declare namespace TsConfigJson {
 		/**
 		Generates a sourcemap for each corresponding `.d.ts` file.
 
-		Requires TypeScript version 2.9 or later.
-
 		@default false
 		*/
 		declarationMap?: boolean;
@@ -944,8 +891,6 @@ declare namespace TsConfigJson {
 		/**
 		Include modules imported with `.json` extension.
 
-		Requires TypeScript version 2.9 or later.
-
 		@default false
 		*/
 		resolveJsonModule?: boolean;
@@ -953,8 +898,6 @@ declare namespace TsConfigJson {
 		/**
 		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;
@@ -983,8 +926,6 @@ declare namespace TsConfigJson {
 		/**
 		Opt a project out of multi-project reference checking when editing.
 
-		Requires TypeScript version 3.8 or later.
-
 		@default false
 		*/
 		disableSolutionSearching?: boolean;
@@ -992,11 +933,28 @@ declare namespace TsConfigJson {
 		/**
 		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;
+
+		/**
+		Preserve unused imported values in the JavaScript output that would otherwise be removed.
+
+		@default true
+		*/
+		preserveValueImports?: boolean;
+
+		/**
+		List of file name suffixes to search when resolving a module.
+		*/
+		moduleSuffixes?: string[];
+
+		/**
+		Control what method is used to detect module-format JS files.
+
+		@default 'auto'
+		*/
+		moduleDetection?: CompilerOptions.ModuleDetection;
 	};
 
 	namespace WatchOptions {
@@ -1026,8 +984,6 @@ declare namespace TsConfigJson {
 		/**
 		Specify the strategy for watching individual files.
 
-		Requires TypeScript version 3.8 or later.
-
 		@default 'UseFsEvents'
 		*/
 		watchFile?: WatchOptions.WatchFileKind | Lowercase<WatchOptions.WatchFileKind>;
@@ -1035,16 +991,12 @@ declare namespace TsConfigJson {
 		/**
 		Specify the strategy for watching directories under systems that lack recursive file-watching functionality.
 
-		Requires TypeScript version 3.8 or later.
-
 		@default 'UseFsEvents'
 		*/
 		watchDirectory?: WatchOptions.WatchDirectoryKind | Lowercase<WatchOptions.WatchDirectoryKind>;
 
 		/**
 		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?: WatchOptions.PollingWatchKind | Lowercase<WatchOptions.PollingWatchKind>;
 
@@ -1066,8 +1018,6 @@ declare namespace TsConfigJson {
 
 	/**
 	Auto type (.d.ts) acquisition options for this project.
-
-	Requires TypeScript version 2.1 or later.
 	*/
 	export type TypeAcquisition = {
 		/**
@@ -1129,8 +1079,6 @@ export type TsConfigJson = {
 
 	/**
 	Auto type (.d.ts) acquisition options for this project.
-
-	Requires TypeScript version 2.1 or later.
 	*/
 	typeAcquisition?: TsConfigJson.TypeAcquisition;
 
@@ -1141,8 +1089,6 @@ export type TsConfigJson = {
 
 	/**
 	Path to base configuration file to inherit from.
-
-	Requires TypeScript version 2.1 or later.
 	*/
 	extends?: string;
 
@@ -1162,15 +1108,11 @@ export type TsConfigJson = {
 	Specifies a list of glob patterns that match files to be included in compilation.
 
 	If no `files` or `include` property is present in a `tsconfig.json`, the compiler defaults to including all files in the containing directory and subdirectories except those specified by `exclude`.
-
-	Requires TypeScript version 2.0 or later.
 	*/
 	include?: string[];
 
 	/**
 	Referenced projects.
-
-	Requires TypeScript version 3.0 or later.
 	*/
 	references?: TsConfigJson.References[];
 };