import type {If} from '../if.js'; import type {IsNever} from '../is-never.js'; import type {UnknownArray} from '../unknown-array.d.ts'; /** Infer the length of the given array ``. @link https://itnext.io/implementing-arithmetic-within-typescripts-type-system-a1ef140a6f6f */ type ArrayLength = T extends {readonly length: infer L} ? L : never; /** Matches any unknown array or tuple. */ export type UnknownArrayOrTuple = readonly [...unknown[]]; // TODO: should unknown-array be updated? /** Extracts the type of the first element of an array or tuple. */ export type FirstArrayElement = TArray extends readonly [infer THead, ...unknown[]] ? THead : never; /** 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 extends readonly unknown[] ? T[0] : never; /** Returns the static, fixed-length portion of the given array, excluding variable-length parts. @example ``` type A = [string, number, boolean, ...string[]]; type B = StaticPartOfArray; //=> [string, number, boolean] ``` */ export type StaticPartOfArray = T extends unknown ? number extends T['length'] ? T extends readonly [infer U, ...infer V] ? StaticPartOfArray : Result : T : never; // Should never happen /** Returns the variable, non-fixed-length portion of the given array, excluding static-length parts. @example ``` type A = [string, number, boolean, ...string[]]; type B = VariablePartOfArray; //=> string[] ``` */ export type VariablePartOfArray = T extends unknown ? T extends readonly [...StaticPartOfArray, ...infer U] ? U : [] : never; // Should never happen /** Set the given array to readonly if `IsReadonly` is `true`, otherwise set the given array to normal, then return the result. @example ``` type ReadonlyArray = readonly string[]; type NormalArray = string[]; type ReadonlyResult = SetArrayAccess; //=> readonly string[] type NormalResult = SetArrayAccess; //=> string[] ``` */ export type SetArrayAccess = T extends readonly [...infer U] ? IsReadonly extends true ? readonly [...U] : [...U] : T; /** Returns whether the given array `T` is readonly. */ export type IsArrayReadonly = If, false, T extends unknown[] ? false : true>; /** Returns a boolean for whether every element in an array type extends another type. Note: This type is not designed to be used with non-tuple arrays (like `number[]`), tuples with optional elements (like `[1?, 2?, 3?]`), or tuples that contain a rest element (like `[1, 2, ...number[]]`). @example ``` import type {Every} from 'type-fest'; type A = Every<[1, 2, 3], number>; //=> true type B = Every<[1, 2, '3'], number>; //=> false type C = Every<[number, number | string], number>; //=> boolean type D = Every<[true, boolean, true], true>; //=> boolean ``` */ export type Every = TArray extends readonly [infer First, ...infer Rest] ? First extends Type ? Every : false : true;