type-plus 8.0.0-beta.0 → 8.0.0-beta.2

package/src/testing/test_type.ts

@@ -0,0 +1,313 @@
+import type { IsAny } from '../any/is_any.js'
+import type { IsArray } from '../array/is_array.js'
+import type { IsBigint } from '../bigint/is_bigint.js'
+import type { IsBoolean } from '../boolean/is_boolean.js'
+import type { IsFalse } from '../boolean/is_false.js'
+import type { IsTrue } from '../boolean/is_true.js'
+import type { IsEqual } from '../equal/equal.js'
+import type { IsFunction } from '../function/is_function.js'
+import type { IsStrictFunction } from '../function/is_strict_function.js'
+import type { IsNever } from '../never/is_never.js'
+import type { IsNull } from '../null/is_null.js'
+import type { IsNumber } from '../number/is_number.js'
+import type { IsObject } from '../object/is_object.js'
+import type { Assignable } from '../predicates/assignable.js'
+import type { IsString } from '../string/is_string.js'
+import type { IsSymbol } from '../symbol/is_symbol.js'
+import type { IsTuple } from '../tuple/is_tuple.js'
+import type { IsUndefined } from '../undefined/is_undefined.js'
+import type { IsUnknown } from '../unknown/is_unknown.js'
+import type { IsVoid } from '../void/is_void.js'
+
+export namespace testType {
+	export interface TestType {
+		/**
+		 * Check if type `A` is equal to type `B` and `C`.
+		 *
+		 * @return `expected` as `A` for type inspection.
+		 */
+		equal<A, B, C>(expected: IsEqual<A, B> & IsEqual<A, C>): A,
+		/**
+		 * Check if type `A` is equal to type `B`.
+		 *
+		 * @return `expected` as `A` for type inspection.
+		 */
+		equal<A, B>(expected: IsEqual<A, B>): A,
+		/**
+		 * Check if `A` can assign to `B`.
+		 *
+		 * If `A` is a union,
+		 * the check is distributive.
+		 *
+		 * Meaning the result can be `boolean`,
+		 * meaning both `true` and `false` will pass.
+		 *
+		 * If you want to avoid the distributivity,
+		 * use `testType.strictCanAssign()` instead.
+		 *
+		 * @example
+		 * ```ts
+		 * testType.canAssign<123, number> // true
+		 *
+		 * testType.canAssign<number | string, number> // boolean
+		 * ```
+		 *
+		 * @return `expected` as `A` for type inspection.
+		 */
+		canAssign<A, B>(expected: Assignable<A, B>): A,
+		/**
+		 * Check if `A` can fully assign to `B`.
+		 *
+		 * This checks all branches in an union `A` are assignable to `B`.
+		 *
+		 * @example
+		 * ```ts
+		 * testType.strictCanAssign<number | string, number | string> // true
+		 *
+		 * testType.strictCanAssign<number | string, number> // false
+		 * ```
+		 *
+		 * @return `expected` as `A` for type inspection.
+		 */
+		strictCanAssign<A, B>(expected: Assignable<A, B, { distributive: false }>): A,
+		/**
+		 * Check if type `T` is exactly `any`.
+		 *
+		 * @return `expected` as `T` for type inspection.
+		 */
+		any<T>(expected: IsAny<T>): T,
+		/**
+		 * Check if type `T` is exactly `array`.
+		 *
+		 * @return `expected` as `T` for type inspection.
+		 */
+		array<T>(expected: IsArray<T, { exact: true }>): T,
+		/**
+		 * Check if type `T` is exactly `bigint`.
+		 *
+		 * @return `expected` as `T` for type inspection.
+		 */
+		strictBigint<T>(expected: IsBigint<T, { distributive: false, exact: true }>): T,
+		/**
+		 * Check if type `T` is `bigint` or bigint literals.
+		 *
+		 * @return `expected` as `T` for type inspection.
+		 */
+		bigint<T>(expected: IsBigint<T, { distributive: false }>): T,
+		/**
+		 * Check if type `T` is exactly `boolean`.
+		 *
+		 * @return `expected` as `T` for type inspection.
+		 */
+		strictBoolean<T>(expected: IsBoolean<T, { distributive: false, exact: true }>): T,
+		/**
+		 * Check if type `T` is `boolean` and boolean literals.
+		 *
+		 * @return `expected` as `T` for type inspection.
+		 */
+		boolean<T>(expected: IsBoolean<T, { distributive: false }>): T,
+		/**
+		 * Check if type `T` is exactly `true`.
+		 *
+		 * @return `expected` as `T` for type inspection.
+		 */
+		true<T>(expected: IsTrue<T, { distributive: false }>): T,
+		/**
+		 * Check if type `T` is exactly `false`.
+		 *
+		 * @return `expected` as `T` for type inspection.
+		 */
+		false<T>(expected: IsFalse<T, { distributive: false }>): T,
+		/**
+		 * Check if type `T` is exactly `boolean`.
+		 *
+		 * @return `expected` as `T` for type inspection.
+		 */
+		strictFunction<T>(expected: IsStrictFunction<T, { distributive: false }>): T,
+		/**
+		 * Check if type `T` is `boolean` and boolean literals.
+		 *
+		 * @return `expected` as `T` for type inspection.
+		 */
+		function<T>(expected: IsFunction<T, { distributive: false }>): T,
+		/**
+		 * Check if type `T` is exactly `never`.
+		 *
+		 * @return `expected` as `T` for type inspection.
+		 */
+		never<T>(expected: IsNever<T>): T,
+		/**
+		 * Check if type `T` is exactly `null`.
+		 *
+		 * @return `expected` as `T` for type inspection.
+		 */
+		null<T>(expected: IsNull<T, { distributive: false }>): T,
+		/**
+		 * Check if type `T` is exactly `number`.
+		 *
+		 * @return `expected` as `T` for type inspection.
+		 */
+		strictNumber<T>(expected: IsNumber<T, { distributive: false, exact: true }>): T,
+		/**
+		 * Check if type `T` is `number` or number literals.
+		 *
+		 * @return `expected` as `T` for type inspection.
+		 */
+		number<T>(expected: IsNumber<T, { distributive: false }>): T,
+		/**
+		 * Check if type `T` is `object`.
+		 *
+		 * Note that `Function`, `Array`, and *tuple* are also `object`.
+		 *
+		 * @return `expected` as `T` for type inspection.
+		 */
+		object<T>(expected: IsObject<T, { distributive: false }>): T,
+		/**
+		 * Check if type `T` is exactly `string`.
+		 *
+		 * @return `expected` as `T` for type inspection.
+		 */
+		strictString<T>(expected: IsString<T, { distributive: false, exact: true }>): T,
+		/**
+		 * Check if type `T` is `string` or string literals.
+		 *
+		 * @return `expected` as `T` for type inspection.
+		 */
+		string<T>(expected: IsString<T, { distributive: false }>): T,
+		/**
+		 * Check if type `T` is a `symbol`.
+		 *
+		 * @return `expected` as `T` for type inspection.
+		 */
+		symbol<T>(expected: IsSymbol<T, { distributive: false }>): T,
+		/**
+		 * Check if type `T` is a *tuple*.
+		 *
+		 * @return `expected` as `T` for type inspection.
+		 */
+		tuple<T>(expected: IsTuple<T, { distributive: false }>): T,
+		/**
+		 * Check if type `T` is exactly `undefined`.
+		 *
+		 * @return `expected` as `T` for type inspection.
+		 */
+		undefined<T>(expected: IsUndefined<T, { distributive: false }>): T,
+		// hasUndefined<T>(expected: CanAssign<T, undefined>): T
+		/**
+		 * Check if type `T` is exactly `unknown`.
+		 *
+		 * @return `expected` as `T` for type inspection.
+		 */
+		unknown<T>(expected: IsUnknown<T>): T,
+		/**
+		 * Check if type `T` is exactly `void`.
+		 *
+		 * @return `expected` as `T` for type inspection.
+		 */
+		void<T>(expected: IsVoid<T, { distributive: false }>): T,
+		/**
+		 * A quick way to inspect a type.
+		 *
+		 * The handler receives a `InspectedType` object.
+		 * It contains `value` which is typed to `T`,
+		 * and many other properties to inspect the behavior of `T`.
+		 *
+		 * The handler is not being call,
+		 * it is use to hold the type in value for inspection.
+		 *
+		 * 🧪 *testing*
+		 * 🦴 *utilities*
+		 *
+		 * @example
+		 * ```ts
+		 * testType.inspect<SomeType>(t => {
+		 *   type T = typeof t.value // resolve and inspect the type `T`
+		 *   t.extend_boolean // result of `T extends boolean`
+		 * })
+		 * ```
+		 *
+		 * After trying out the type, remove the line.
+		 */
+		inspect<T>(handler: (t: InspectedType<T>) => unknown): T
+	}
+
+	export type InspectedType<T> = {
+		type: T,
+		extends<R>(): T extends R ? true : false,
+		extends_any: T extends any ? true : false,
+		extends_unknown: T extends unknown ? true : false,
+		extends_void: T extends void ? true : false,
+		extends_never: T extends never ? true : false,
+		extends_undefined: T extends undefined ? true : false,
+		extends_null: T extends null ? true : false,
+		extends_boolean: T extends boolean ? true : false,
+		extends_true: T extends true ? true : false,
+		extends_false: T extends false ? true : false,
+		extends_number: T extends number ? true : false,
+		extends_1: T extends 1 ? true : false,
+		extends_bigint: T extends bigint ? true : false,
+		extends_1n: T extends 1n ? true : false,
+		extends_string: T extends string ? true : false,
+		extends_a: T extends 'a' ? true : false,
+		extends_symbol: T extends symbol ? true : false,
+		extends_object: T extends object ? true : false,
+		extends_function: T extends Function ? true : false,
+		extends_array_unknown: T extends unknown[] ? true : false,
+		extends_tuple_empty: T extends [] ? true : false,
+		union<R>(): T | R,
+		union_any: T | any,
+		union_unknown: T | unknown,
+		union_void: T | void,
+		union_never: T | never,
+		union_undefined: T | undefined,
+		union_null: T | null,
+		union_boolean: T | boolean,
+		union_true: T | true,
+		union_false: T | false,
+		union_number: T | number,
+		union_1: T | 1,
+		union_bigint: T | bigint,
+		union_1n: T | 1n,
+		union_string: T | string,
+		union_a: T | 'a',
+		union_symbol: T | symbol,
+		union_object: T | object,
+		union_function: T | Function,
+		union_array_unknown: T | unknown[],
+		union_tuple_empty: T | [],
+		intersect<R>(): T & R,
+		intersect_any: T & any,
+		intersect_unknown: T & unknown,
+		intersect_void: T & void,
+		intersect_never: T & never,
+		intersect_undefined: T & undefined,
+		intersect_null: T & null,
+		intersect_boolean: T & boolean,
+		intersect_true: T & true,
+		intersect_false: T & false,
+		intersect_number: T & number,
+		intersect_1: T & 1,
+		intersect_bigint: T & bigint,
+		intersect_1n: T & 1n,
+		intersect_string: T & string,
+		intersect_a: T & 'a',
+		intersect_symbol: T & symbol,
+		intersect_object: T & object,
+		intersect_function: T & Function,
+		intersect_array_unknown: T & unknown[],
+		intersect_tuple_empty: T & []
+	}
+}
+
+/**
+ * Test utilities for types.
+ *
+ * This is designed specifically for testing.
+ * The return value is the input `expected` parameter asserted as the first type parameter,
+ * so that the type can be further inspected.
+ */
+export const testType = new Proxy({} as testType.TestType, {
+	get(_target, _prop, _receiver) {
+		return (expected: unknown) => expected
+	}
+})

package/src/tuple/create_tuple.ts

@@ -0,0 +1,42 @@
+import type { DigitArray } from '../math/numeric_struct.js'
+import type { IsInteger } from '../numeric/is_integer.js'
+import type { IsPositive } from '../numeric/is_positive.js'
+
+/**
+ * Creates `Tuple<T>` with `L` number of elements.
+ * @note Other cool implementations by @lazytype, @jcalz:
+ * @see https://github.com/microsoft/TypeScript/issues/26223#issuecomment-674514787
+ * @see https://github.com/microsoft/TypeScript/issues/47874#issuecomment-1039157322
+ */
+export type CreateTuple<L extends number, T = unknown, Fail = never> = number extends L
+	? T[]
+	: IsPositive<L> extends true
+	? IsInteger<L> extends true
+		? ToTuple<[], DigitArray.FromString<`${L}`>, T>
+		: Fail
+	: Fail
+export type ToTuple<R extends any[], S extends number[], X = any> = S['length'] extends 0
+	? R
+	: S['length'] extends 1
+	? [...R, ...DigitToTuple<X>[S[0]]]
+	: S extends [any, ...infer T]
+	? T extends any[]
+		? ToTuple<Multi10<[...R, ...DigitToTuple<X>[S[0]]]>, T>
+		: never
+	: never
+
+type DigitToTuple<T = 1> = {
+	[k in number]: any[]
+} & {
+	0: [],
+	1: [T],
+	2: [T, T],
+	3: [T, T, T],
+	4: [T, T, T, T],
+	5: [T, T, T, T, T],
+	6: [T, T, T, T, T, T],
+	7: [T, T, T, T, T, T, T],
+	8: [T, T, T, T, T, T, T, T],
+	9: [T, T, T, T, T, T, T, T, T]
+}
+type Multi10<C extends any[]> = [...C, ...C, ...C, ...C, ...C, ...C, ...C, ...C, ...C, ...C]

package/src/tuple/is_not_tuple.ts

@@ -0,0 +1,101 @@
+import type { NotAssignable } from '../predicates/not_assignable.js'
+import type { $Equality } from '../type_plus/$equality.js'
+import type { $MergeOptions } from '../type_plus/$merge_options.js'
+import type { $SpecialType } from '../type_plus/$special_type.js'
+import type { $IsDistributive } from '../type_plus/branch/$is_distributive.js'
+import type { $ResolveBranch } from '../type_plus/branch/$resolve_branch.js'
+import type { $Else, $Then } from '../type_plus/branch/$selection.js'
+
+/**
+ * 🎭 *predicate*
+ *
+ * Validate that `T` is not a tuple, excluding array.
+ *
+ * ```ts
+ * type R = IsNotTuple<[]>       // false
+ * type R = IsNotTuple<[1]>      // false
+ *
+ * type R = IsNotTuple<number[]> // true
+ * type R = IsNotTuple<string>   // true
+ * type R = IsNotTuple<never>    // true
+ * type R = IsNotTuple<unknown>  // true
+ * ```
+ *
+ * 🔢 *customize*
+ *
+ * Filter to ensure `T` is not a `tuple`, otherwise returns `never`.
+ *
+ * @example
+ * ```ts
+ * type R = IsNotTuple<[], { selection: 'filter' }> // never
+ * type R = IsNotTuple<[1], { selection: 'filter' }> // never
+ *
+ * type R = IsNotTuple<never, { selection: 'filter' }> // never
+ * type R = IsNotTuple<unknown, { selection: 'filter' }> // unknown
+ * type R = IsNotTuple<[] | boolean, { selection: 'filter' }> // boolean
+ * type R = IsNotTuple<[1] | bigint> // bigint
+ * ```
+ *
+ * 🔢 *customize*:
+ *
+ * Disable distribution of union types.
+ *
+ * ```ts
+ * type R = IsNotTuple<[] | 1> // boolean
+ * type R = IsNotTuple<[] | 1, { distributive: false }> // false
+ * ```
+ *
+ * 🔢 *customize*
+ *
+ * Use unique branch identifiers to allow precise processing of the result.
+ *
+ * @example
+ * ```ts
+ * type R = IsNotTuple<bigint, IsNotTuple.$Branch> // $Then
+ * type R = IsNotTuple<[], IsNotTuple.$Branch> // $Else
+ * ```
+ */
+export type IsNotTuple<
+	T,
+	$O extends IsNotTuple.$Options = {}
+> = $SpecialType<T,
+	$MergeOptions<$O,
+		{
+			$then: $ResolveBranch<T, $O, [$Then]>,
+			$else: IsNotTuple.$<T, $O>
+		}
+	>
+>
+
+export namespace IsNotTuple {
+	export type $Options = $Equality.$Options
+	export type $Branch<$O extends $Options = {}> = $Equality.$Branch<$O>
+	// export type $Default = $Select.$Default
+
+	/**
+	 * 🧰 *type util*
+	 *
+	 * Validate if `T` is `bigint` or `bigint` literals.
+	 *
+	 * This is a type util for building custom types.
+	 * It does not check against special types.
+	 */
+	export type $<T, $O extends $UtilOptions> = $IsDistributive<$O, {
+		$then: T extends readonly any[]
+		? (
+			number extends T['length']
+			? $ResolveBranch<T, $O, [$Then]>
+			: $ResolveBranch<T, $O, [$Else]>
+		)
+		: $ResolveBranch<T, $O, [$Then]>,
+		$else: [T] extends [readonly any[]]
+		? (
+			number extends T['length']
+			? $ResolveBranch<T, $O, [$Then]>
+			: $ResolveBranch<T, $O, [$Else]>
+		)
+		: $ResolveBranch<T, $O, [$Then]>
+	}>
+
+	export type $UtilOptions = NotAssignable.$UtilOptions
+}

package/src/tuple/is_tuple.ts

@@ -0,0 +1,99 @@
+import type { Assignable } from '../predicates/assignable.js'
+import type { $Equality } from '../type_plus/$equality.js'
+import type { $MergeOptions } from '../type_plus/$merge_options.js'
+import type { $SpecialType } from '../type_plus/$special_type.js'
+import type { $IsDistributive } from '../type_plus/branch/$is_distributive.js'
+import type { $ResolveBranch } from '../type_plus/branch/$resolve_branch.js'
+import type { $Else, $Then } from '../type_plus/branch/$selection.js'
+
+/**
+ * 🎭 *predicate*
+ *
+ * Validate that `T` is a tuple, excluding array.
+ *
+ * ```ts
+ * type R = IsTuple<[]>       // true
+ *
+ * type R = IsTuple<number[]> // false
+ * type R = IsTuple<string>   // false
+ * type R = IsTuple<never>    // false
+ * type R = IsTuple<unknown>  // false
+ * ```
+ *
+ * 🔢 *customize*
+ *
+ * Filter to ensure `T` is a `tuple`, otherwise returns `never`.
+ *
+ * @example
+ * ```ts
+ * type R = IsTuple<[], { selection: 'filter' }> // []
+ * type R = IsTuple<[1], { selection: 'filter' }> // [1]
+ *
+ * type R = IsTuple<never, { selection: 'filter' }> // never
+ * type R = IsTuple<unknown, { selection: 'filter' }> // never
+ * type R = IsTuple<[] | boolean, { selection: 'filter' }> // []
+ * ```
+ *
+ * 🔢 *customize*:
+ *
+ * Disable distribution of union types.
+ *
+ * ```ts
+ * type R = IsTuple<[1] | 1> // boolean
+ * type R = IsTuple<[] | 1, { distributive: false }> // false
+ * ```
+ *
+ * 🔢 *customize*
+ *
+ * Use unique branch identifiers to allow precise processing of the result.
+ *
+ * @example
+ * ```ts
+ * type R = IsTuple<[], IsTuple.$Branch> // $Then
+ * type R = IsTuple<string, IsTuple.$Branch> // $Else
+ * ```
+ */
+export type IsTuple<
+	T,
+	$O extends IsTuple.$Options = {}
+> =
+	$SpecialType<T,
+		$MergeOptions<$O,
+			{
+				$then: $ResolveBranch<T, $O, [$Else]>,
+				$else: IsTuple.$<T, $O>
+			}
+		>
+	>
+
+export namespace IsTuple {
+	export type $Options = $Equality.$Options
+	export type $Branch<$O extends $Options = {}> = $Equality.$Branch<$O>
+
+	/**
+	 * 🧰 *type util*
+	 *
+	 * Validate if `T` is `tuple`.
+	 *
+	 * This is a type util for building custom types.
+	 * It does not check against special types.
+	 */
+	export type $<T, $O extends $UtilOptions> = $IsDistributive<$O, {
+		$then: T extends readonly any[]
+		? (
+			number extends T['length']
+			? $ResolveBranch<T, $O, [$Else]>
+			: $ResolveBranch<T, $O, [$Then]>
+		)
+		: $ResolveBranch<T, $O, [$Else]>,
+		$else: [T] extends [readonly any[]]
+		? (
+			number extends T['length']
+			? $ResolveBranch<T, $O, [$Else]>
+			: $ResolveBranch<T, $O, [$Then]>
+		)
+		: $ResolveBranch<T, $O, [$Else]>
+	}>
+
+	export type $UtilOptions = Assignable.$UtilOptions
+}