type-fest 3.3.0 → 3.4.0

package/index.d.ts

@@ -101,5 +101,6 @@ export type {Get} from './source/get';
 export type {LastArrayElement} from './source/last-array-element';
 
 // Miscellaneous
+export type {GlobalThis} from './source/global-this';
 export type {PackageJson} from './source/package-json';
 export type {TsConfigJson} from './source/tsconfig-json';

package/package.json

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

package/readme.md

@@ -236,6 +236,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/).
 - [`TsConfigJson`](source/tsconfig-json.d.ts) - Type for [TypeScript's `tsconfig.json` file](https://www.typescriptlang.org/docs/handbook/tsconfig-json.html).
 
@@ -623,13 +624,13 @@ There are many advanced types most users don't know about.
 		// Mutate array randomly changing its' elements indexes.
 	}
 
-	function callNTimes<Fn extends (...args: any[]) => any> (func: Fn, callCount: number) {
+	function callNTimes<Fn extends (...arguments_: any[]) => any> (func: Fn, callCount: number) {
 		// Type that represents the type of the received function parameters.
 		type FunctionParameters = Parameters<Fn>;
 
-		return function (...args: FunctionParameters) {
+		return function (...arguments_: FunctionParameters) {
 			for (let i = 0; i < callCount; i++) {
-				func(...args);
+				func(...arguments_);
 			}
 		}
 	}
@@ -656,7 +657,7 @@ There are many advanced types most users don't know about.
 		}
 	}
 
-	class InstanceCache<T extends (new (...args: any[]) => any)> {
+	class InstanceCache<T extends (new (...arguments_: any[]) => any)> {
 		private ClassConstructor: T;
 		private cache: Map<string, InstanceType<T>> = new Map();
 
@@ -664,18 +665,18 @@ There are many advanced types most users don't know about.
 			this.ClassConstructor = ctr;
 		}
 
-		getInstance (...args: ConstructorParameters<T>): InstanceType<T> {
-			const hash = this.calculateArgumentsHash(...args);
+		getInstance (...arguments_: ConstructorParameters<T>): InstanceType<T> {
+			const hash = this.calculateArgumentsHash(...arguments_);
 
 			const existingInstance = this.cache.get(hash);
 			if (existingInstance !== undefined) {
 				return existingInstance;
 			}
 
-			return new this.ClassConstructor(...args);
+			return new this.ClassConstructor(...arguments_);
 		}
 
-		private calculateArgumentsHash(...args: any[]): string {
+		private calculateArgumentsHash(...arguments_: any[]): string {
 			// Calculate hash.
 			return 'hash';
 		}
@@ -747,17 +748,17 @@ There are many advanced types most users don't know about.
 	const instanceCounter: Map<Function, number> = new Map();
 
 	interface Constructor {
-			new(...args: any[]): any;
+			new(...arguments_: any[]): any;
 	}
 
 	// Keep track how many instances of `Constr` constructor have been created.
 	function getInstance<
 			Constr extends Constructor,
-			Args extends ConstructorParameters<Constr>
-	>(constructor: Constr, ...args: Args): InstanceType<Constr> {
+			Arguments extends ConstructorParameters<Constr>
+	>(constructor: Constr, ...arguments_: Arguments): InstanceType<Constr> {
 			let count = instanceCounter.get(constructor) || 0;
 
-			const instance = new constructor(...args);
+			const instance = new constructor(...arguments_);
 
 			instanceCounter.set(constructor, count + 1);
 

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

@@ -1,4 +1,4 @@
-type AsyncFunction = (...args: any[]) => Promise<unknown>;
+type AsyncFunction = (...arguments_: any[]) => Promise<unknown>;
 
 /**
 Unwrap the return type of a function that returns a `Promise`.

package/source/asyncify.d.ts

@@ -29,4 +29,4 @@ const getFooAsync: AsyncifiedFooGetter = (someArg) => {
 
 @category Async
 */
-export type Asyncify<Fn extends (...args: any[]) => any> = SetReturnType<Fn, Promise<Awaited<ReturnType<Fn>>>>;
+export type Asyncify<Fn extends (...arguments_: any[]) => any> = SetReturnType<Fn, Promise<Awaited<ReturnType<Fn>>>>;

package/source/exact.d.ts

@@ -1,20 +1,5 @@
-import type {KeysOfUnion} from './internal';
-
-/**
-Extract the element of an array that also works for array union.
-
-Returns `never` if T is not an array.
-
-It creates a type-safe way to access the element type of `unknown` type.
-*/
-type ArrayElement<T> = T extends readonly unknown[] ? T[0] : never;
-
-/**
-Extract the object field type if T is an object and K is a key of T, return `never` otherwise.
-
-It creates a type-safe way to access the member type of `unknown` type.
-*/
-type ObjectValue<T, K> = K extends keyof T ? T[K] : never;
+import type {KeysOfUnion, ArrayElement, ObjectValue} from './internal';
+import type {Opaque} from './opaque';
 
 /**
 Create a type from `ParameterType` and `InputType` and change keys exclusive to `InputType` to `never`.
@@ -35,7 +20,7 @@ This is useful for function type-guarding to reject arguments with excess proper
 ```
 type OnlyAcceptName = {name: string};
 
-function onlyAcceptName(args: OnlyAcceptName) {}
+function onlyAcceptName(arguments_: OnlyAcceptName) {}
 
 // TypeScript complains about excess properties when an object literal is provided.
 onlyAcceptName({name: 'name', id: 1});
@@ -54,7 +39,7 @@ import {Exact} from 'type-fest';
 
 type OnlyAcceptName = {name: string};
 
-function onlyAcceptNameImproved<T extends Exact<OnlyAcceptName, T>>(args: T) {}
+function onlyAcceptNameImproved<T extends Exact<OnlyAcceptName, T>>(arguments_: T) {}
 
 const invalidInput = {name: 'name', id: 1};
 onlyAcceptNameImproved(invalidInput); // Compilation error
@@ -69,5 +54,7 @@ export type Exact<ParameterType, InputType> =
 	ParameterType extends unknown[] ? Array<Exact<ArrayElement<ParameterType>, ArrayElement<InputType>>>
 	// In TypeScript, Array is a subtype of ReadonlyArray, so always test Array before ReadonlyArray.
 		: ParameterType extends readonly unknown[] ? ReadonlyArray<Exact<ArrayElement<ParameterType>, ArrayElement<InputType>>>
-			: ParameterType extends object ? ExactObject<ParameterType, InputType>
-				: ParameterType;
+			// For Opaque types, internal details are hidden from public, so let's leave it as is.
+			: ParameterType extends Opaque<infer OpaqueType, infer OpaqueToken> ? ParameterType
+				: ParameterType extends object ? ExactObject<ParameterType, InputType>
+					: ParameterType;

package/source/global-this.d.ts

@@ -0,0 +1,21 @@
+/**
+Declare locally scoped properties on `globalThis`.
+
+When defining a global variable in a declaration file is inappropriate, it can be helpful to define a `type` or `interface` (say `ExtraGlobals`) with the global variable and then cast `globalThis` via code like `globalThis as unknown as ExtraGlobals`.
+
+Instead of casting through `unknown`, you can update your `type` or `interface` to extend `GlobalThis` and then directly cast `globalThis`.
+
+@example
+```
+import type {GlobalThis} from 'type-fest';
+
+type ExtraGlobals = GlobalThis & {
+	readonly GLOBAL_TOKEN: string;
+};
+
+(globalThis as ExtraGlobals).GLOBAL_TOKEN;
+```
+
+@category Type
+*/
+export type GlobalThis = typeof globalThis;

package/source/internal.d.ts

@@ -95,6 +95,22 @@ Extracts the type of an array or tuple minus the first element.
 */
 export type ArrayTail<TArray extends UnknownArrayOrTuple> = TArray extends readonly [unknown, ...infer TTail] ? TTail : [];
 
+/**
+Extract the element of an array that also works for array union.
+
+Returns `never` if T is not an array.
+
+It creates a type-safe way to access the element type of `unknown` type.
+*/
+export type ArrayElement<T> = T extends readonly unknown[] ? T[0] : never;
+
+/**
+Extract the object field type if T is an object and K is a key of T, return `never` otherwise.
+
+It creates a type-safe way to access the member type of `unknown` type.
+*/
+export type ObjectValue<T, K> = K extends keyof T ? T[K] : never;
+
 /**
 Returns a boolean for whether the string is lowercased.
 */
@@ -117,6 +133,16 @@ Returns a boolean for whether the the type is `any`.
 */
 export type IsAny<T> = 0 extends 1 & T ? true : false;
 
+/**
+Returns a boolean for whether the the type is `never`.
+*/
+export type IsNever<T> = [T] extends [never] ? true : false;
+
+/**
+Returns a boolean for whether the the type is `unknown`.
+*/
+export type IsUnknown<T> = IsNever<T> extends false ? T extends unknown ? unknown extends T ? IsAny<T> extends false ? true : false : false : false : false;
+
 /**
 For an object T, if it has any properties that are a union with `undefined`, make those into optional properties instead.
 
@@ -149,7 +175,7 @@ type BaseKeyFilter<Type, Key extends keyof Type> = Key extends symbol
 	? never
 	: Type[Key] extends symbol
 		? never
-		: [(...args: any[]) => any] extends [Type[Key]]
+		: [(...arguments_: any[]) => any] extends [Type[Key]]
 			? never
 			: Key;
 

package/source/jsonify.d.ts

@@ -5,7 +5,7 @@ import type {NegativeInfinity, PositiveInfinity} from './numeric';
 import type {TypedArray} from './typed-array';
 
 // Note: The return value has to be `any` and not `unknown` so it can match `void`.
-type NotJsonable = ((...args: any[]) => any) | undefined | symbol;
+type NotJsonable = ((...arguments_: any[]) => any) | undefined | symbol;
 
 type JsonifyTuple<T extends [unknown, ...unknown[]]> = {
 	[Key in keyof T]: T[Key] extends NotJsonable ? null : Jsonify<T[Key]>;
@@ -35,7 +35,7 @@ An interface cannot be structurally compared to `JsonValue` because an interface
 
 @example
 ```
-import type {Jsonify} from 'type-fest';
+import type {Jsonify, JsonValue} from 'type-fest';
 
 interface Geometry {
 	type: 'Point' | 'Polygon';

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

@@ -1,7 +1,4 @@
-import type {IsAny} from './internal';
-
-type IsNever<T> = [T] extends [never] ? true : false;
-type IsUnknown<T> = IsNever<T> extends false ? T extends unknown ? unknown extends T ? IsAny<T> extends false ? true : false : false : false : false;
+import type {IsUnknown} from './internal';
 
 /**
 Create a function type with a return type of your choice and the same parameters as the given function type.
@@ -20,13 +17,13 @@ type MyWrappedFunction = SetReturnType<MyFunctionThatCanThrow, SomeOtherType | u
 
 @category Function
 */
-export type SetReturnType<Fn extends (...args: any[]) => any, TypeToReturn> =
+export type SetReturnType<Fn extends (...arguments_: any[]) => any, TypeToReturn> =
 	// Just using `Parameters<Fn>` isn't ideal because it doesn't handle the `this` fake parameter.
-	Fn extends (this: infer ThisArg, ...args: infer Arguments) => any ? (
+	Fn extends (this: infer ThisArg, ...arguments_: infer Arguments) => any ? (
 		// If a function did not specify the `this` fake parameter, it will be inferred to `unknown`.
 		// We want to detect this situation just to display a friendlier type upon hovering on an IntelliSense-powered IDE.
-		IsUnknown<ThisArg> extends true ? (...args: Arguments) => TypeToReturn : (this: ThisArg, ...args: Arguments) => TypeToReturn
+		IsUnknown<ThisArg> extends true ? (...arguments_: Arguments) => TypeToReturn : (this: ThisArg, ...arguments_: Arguments) => TypeToReturn
 	) : (
 		// This part should be unreachable, but we make it meaningful just in case…
-		(...args: Parameters<Fn>) => TypeToReturn
+		(...arguments_: Parameters<Fn>) => TypeToReturn
 	);