utilium 0.1.10 → 0.1.11

package/dist/types.d.ts

@@ -64,4 +64,106 @@ type StrictUnionHelper<T, TAll> = T extends unknown ? T & Partial<Record<Exclude
  * @see https://stackoverflow.com/a/65805753/17637456
  */
 export type StrictUnion<T> = Expand<StrictUnionHelper<T, T>>;
+/**
+ * Empty
+ */
+export type Empty = [];
+/**
+ * Removes the first element of T and shifts
+ */
+export type Shift<T> = T extends unknown[] ? (((...x: T) => void) extends (h: any, ...t: infer I) => void ? I : []) : unknown;
+/**
+ * Gets the first element of T
+ */
+export type First<T> = T extends unknown[] ? (((...x: T) => void) extends (h: infer I, ...t: any) => void ? I : []) : never;
+/**
+ * Inserts A into T at the start of T
+ */
+export type Unshift<T, A> = T extends unknown[] ? (((h: A, ...t: T) => void) extends (...i: infer I) => void ? I : unknown) : never;
+/**
+ * Removes the last element of T
+ */
+export type Pop<T> = T extends unknown[] ? (((...x: T) => void) extends (...i: [...infer I, any]) => void ? I : unknown) : never;
+/**
+ * Gets the last element of T
+ */
+export type Last<T> = T extends unknown[] ? (((...x: T) => void) extends (...i: [...infer H, infer I]) => void ? I : unknown) : never;
+/**
+ * Appends A to T
+ */
+export type Push<T, A> = T extends unknown[] ? (((...a: [...T, A]) => void) extends (...i: infer I) => void ? I : unknown) : never;
+/**
+ * Concats A and B
+ */
+export type Concat<A, B> = {
+    0: A;
+    1: Concat<Unshift<A, 0>, Shift<B>>;
+}[Empty extends B ? 0 : 1];
+/**
+ * Extracts from A what is not B
+ *
+ * @remarks
+ * It does not remove duplicates (so Remove\<[0, 0, 0], [0, 0]\> yields [0]). This is intended and necessary behavior.
+ */
+export type Remove<A, B> = {
+    0: A;
+    1: Remove<Shift<A>, Shift<B>>;
+}[Empty extends B ? 0 : 1];
+/**
+ * The length of T
+ */
+export type Length<T> = T extends {
+    length: number;
+} ? T['length'] : never;
+type _FromLength<N extends number, R = Empty> = {
+    0: R;
+    1: _FromLength<N, Unshift<R, 0>>;
+}[Length<R> extends N ? 0 : 1];
+/**
+ * Creates a tuple of length N
+ */
+export type FromLength<N extends number> = _FromLength<N>;
+/**
+ * Increments N
+ */
+export type Increment<N extends number> = Length<Unshift<_FromLength<N>, 0>>;
+/**
+ * Decrements N
+ */
+export type Decrement<N extends number> = Length<Shift<_FromLength<N>>>;
+/**
+ * Gets the sum of A and B
+ */
+export type Add<A extends number, B extends number> = Length<Concat<_FromLength<A>, _FromLength<B>>>;
+/**
+ * Subtracts B from A
+ */
+export type Subtract<A extends number, B extends number> = Length<Remove<_FromLength<A>, _FromLength<B>>>;
+/**
+ * Gets the type of an array's members
+ */
+export type Member<T, D = null> = D extends 0 ? T : T extends (infer U)[] ? Member<U, D extends number ? Decrement<D> : null> : T;
+/**
+ * Flattens an array
+ */
+export type FlattenArray<A extends unknown[], D = null> = A extends (infer U)[] ? Member<Exclude<U, A>, D>[] : A extends unknown[] ? {
+    [K in keyof A]: Member<A[K], D>;
+} : A;
+/**
+ * Whether T is a tuple
+ */
+export type IsTuple<T> = T extends [] ? false : T extends [infer Head, ...infer Rest] ? true : false;
+/**
+ * Flattens a tuple
+ */
+export type FlattenTuple<A extends unknown[]> = A extends [infer U, ...infer Rest] ? (U extends unknown[] ? [...U, ...FlattenTuple<Rest>] : [U, ...FlattenTuple<Rest>]) : [];
+/**
+ * Flattens an array or tuple
+ */
+export type Flatten<A extends unknown[]> = IsTuple<A> extends true ? FlattenTuple<A> : FlattenArray<A>;
+type _Tuple<T, N extends number, R extends unknown[] = Empty> = R['length'] extends N ? R : _Tuple<T, N, [T, ...R]>;
+/**
+ * Creates a tuple of T with length N
+ */
+export type Tuple<T, N extends number> = _Tuple<T, N>;
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "utilium",
-	"version": "0.1.10",
+	"version": "0.1.11",
 	"description": "Typescript utilies",
 	"main": "dist/index.js",
 	"types": "dist/index.d.ts",

package/src/types.ts

@@ -74,3 +74,119 @@ type StrictUnionHelper<T, TAll> = T extends unknown ? T & Partial<Record<Exclude
  * @see https://stackoverflow.com/a/65805753/17637456
  */
 export type StrictUnion<T> = Expand<StrictUnionHelper<T, T>>;
+
+// Tuple and array manipulation
+
+/**
+ * Empty
+ */
+export type Empty = [];
+
+/**
+ * Removes the first element of T and shifts
+ */
+export type Shift<T> = T extends unknown[] ? (((...x: T) => void) extends (h: any, ...t: infer I) => void ? I : []) : unknown;
+
+/**
+ * Gets the first element of T
+ */
+export type First<T> = T extends unknown[] ? (((...x: T) => void) extends (h: infer I, ...t: any) => void ? I : []) : never;
+
+/**
+ * Inserts A into T at the start of T
+ */
+export type Unshift<T, A> = T extends unknown[] ? (((h: A, ...t: T) => void) extends (...i: infer I) => void ? I : unknown) : never;
+
+/**
+ * Removes the last element of T
+ */
+export type Pop<T> = T extends unknown[] ? (((...x: T) => void) extends (...i: [...infer I, any]) => void ? I : unknown) : never;
+
+/**
+ * Gets the last element of T
+ */
+export type Last<T> = T extends unknown[] ? (((...x: T) => void) extends (...i: [...infer H, infer I]) => void ? I : unknown) : never;
+
+/**
+ * Appends A to T
+ */
+export type Push<T, A> = T extends unknown[] ? (((...a: [...T, A]) => void) extends (...i: infer I) => void ? I : unknown) : never;
+
+/**
+ * Concats A and B
+ */
+export type Concat<A, B> = { 0: A; 1: Concat<Unshift<A, 0>, Shift<B>> }[Empty extends B ? 0 : 1];
+
+/**
+ * Extracts from A what is not B
+ *
+ * @remarks
+ * It does not remove duplicates (so Remove\<[0, 0, 0], [0, 0]\> yields [0]). This is intended and necessary behavior.
+ */
+export type Remove<A, B> = { 0: A; 1: Remove<Shift<A>, Shift<B>> }[Empty extends B ? 0 : 1];
+
+/**
+ * The length of T
+ */
+export type Length<T> = T extends { length: number } ? T['length'] : never;
+
+type _FromLength<N extends number, R = Empty> = { 0: R; 1: _FromLength<N, Unshift<R, 0>> }[Length<R> extends N ? 0 : 1];
+
+/**
+ * Creates a tuple of length N
+ */
+export type FromLength<N extends number> = _FromLength<N>;
+
+// compile-time math
+
+/**
+ * Increments N
+ */
+export type Increment<N extends number> = Length<Unshift<_FromLength<N>, 0>>;
+
+/**
+ * Decrements N
+ */
+export type Decrement<N extends number> = Length<Shift<_FromLength<N>>>;
+
+/**
+ * Gets the sum of A and B
+ */
+export type Add<A extends number, B extends number> = Length<Concat<_FromLength<A>, _FromLength<B>>>;
+
+/**
+ * Subtracts B from A
+ */
+export type Subtract<A extends number, B extends number> = Length<Remove<_FromLength<A>, _FromLength<B>>>;
+
+/**
+ * Gets the type of an array's members
+ */
+export type Member<T, D = null> = D extends 0 ? T : T extends (infer U)[] ? Member<U, D extends number ? Decrement<D> : null> : T;
+
+/**
+ * Flattens an array
+ */
+export type FlattenArray<A extends unknown[], D = null> = A extends (infer U)[] ? Member<Exclude<U, A>, D>[] : A extends unknown[] ? { [K in keyof A]: Member<A[K], D> } : A;
+
+/**
+ * Whether T is a tuple
+ */
+export type IsTuple<T> = T extends [] ? false : T extends [infer Head, ...infer Rest] ? true : false;
+
+/**
+ * Flattens a tuple
+ */
+export type FlattenTuple<A extends unknown[]> = A extends [infer U, ...infer Rest] ? (U extends unknown[] ? [...U, ...FlattenTuple<Rest>] : [U, ...FlattenTuple<Rest>]) : [];
+
+/**
+ * Flattens an array or tuple
+ */
+export type Flatten<A extends unknown[]> = IsTuple<A> extends true ? FlattenTuple<A> : FlattenArray<A>;
+
+type _Tuple<T, N extends number, R extends unknown[] = Empty> = R['length'] extends N ? R : _Tuple<T, N, [T, ...R]>;
+
+/**
+ * Creates a tuple of T with length N
+ */
+export type Tuple<T, N extends number> = _Tuple<T, N>;