type-plus 4.5.2 → 4.6.0

package/README.md

@@ -285,12 +285,14 @@ type No = IsAny<1, 'yes', 'no'> // 'no'
 - `CreateTuple<L, T>`: Creates `Tuple<T>` with `L` number of elements.
 - `DropFirst<A>`: drops the first value type of `A`.
 - `DropLast<A>`: drops the last value type of `A`.
-- `Filter<A, Criteria>`: gets the array of types satisfying `Criteria` in `A`.
+- `DropMatch<A, Criteria>`: drops entries matching `Criteria` in array or tuple `A`.
+- `Filter<A, Criteria>`: filter the array or tuple `A`, keeping entries satisfying `Criteria`. **deprecated. Renaming to `KeepMatch`**
 - `FindFirst<A, Criteria>`: gets the first type satisfying `Criteria`.
 - `FindLast<A, Criteria>`: gets the last type satisfying `Criteria`.
 - `Head<A>`: gets the first entry in the array.
 - `IntersectOfProps<A, K>`: gets the intersect of `A[K]` types (deprecate `MapToProp`)
 - `IsArray<T>`: `logical` predicate for `Array`.
+- `KeepMatch<A, Criteria>`: keeps entries satisfying `Criteria` in array or tuple `A`.
 - `Last<A>`: gets the last type of an array or tuple.
 - `literalArray(...entries)`: return an array whose items are restricted to the provided literals.
 - `PadLeft<A, Total, PadWith>`: pads `A` with `PadWith` if the length of `A` is less than `L`.

package/cjs/array/DropMatch.d.ts

@@ -0,0 +1,5 @@
+import { Equal } from '../predicates';
+declare type ExcludeUnionOfEmptyTuple<A> = Equal<A, []> extends true ? A : Exclude<A, []>;
+export declare type DropMatch<A extends Array<any>, Criteria> = number extends A['length'] ? (A[0] extends Criteria ? never[] : (undefined extends Criteria ? Array<NonNullable<A[0]>> : (Criteria extends A[0] ? Array<Exclude<A[0], Criteria>> : A))) : DropMatchTuple<A, Criteria>;
+declare type DropMatchTuple<A extends Array<any>, Criteria> = (A['length'] extends 0 ? A : (A extends [infer Head, ...infer Tail] ? (Tail['length'] extends 0 ? (undefined extends Criteria ? (Head extends Criteria ? [] : [Head]) : ExcludeUnionOfEmptyTuple<(Head extends Criteria ? [] : [Head])>) : (Exclude<Head, Criteria> extends never ? DropMatch<Tail, Criteria> : [Exclude<Head, Criteria>, ...DropMatch<Tail, Criteria>])) : never[]));
+export {};

package/cjs/array/DropMatch.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=DropMatch.js.map

package/cjs/array/DropMatch.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DropMatch.js","sourceRoot":"","sources":["../../ts/array/DropMatch.ts"],"names":[],"mappings":""}

package/cjs/array/Filter.d.ts

@@ -1 +1,2 @@
 export declare type Filter<A extends Array<any>, Criteria> = number extends A['length'] ? (A[0] extends Criteria ? A : (Criteria extends A[0] ? Array<Criteria> : never[])) : (A['length'] extends 0 ? never : (A extends [infer Head, ...infer Tail] ? (Tail['length'] extends 0 ? (Head extends Criteria ? [Head] : never[]) : (Head extends Criteria ? [Head, ...Filter<Tail, Criteria>] : Filter<Tail, Criteria>)) : never));
+export declare type KeepMatch<A extends Array<any>, Criteria> = Filter<A, Criteria>;

package/cjs/array/index.d.ts

@@ -3,7 +3,8 @@ export type { Concat } from './Concat';
 export type { CreateTuple } from './CreateTuple';
 export type { DropFirst } from './DropFirst';
 export type { DropLast } from './DropLast';
-export type { Filter } from './Filter';
+export type { DropMatch } from './DropMatch';
+export type { Filter, KeepMatch } from './Filter';
 export type { FindFirst, First } from './FindFirst';
 export type { FindLast } from './FindLast';
 export type { Head } from './Head';

package/cjs/array/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../ts/array/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAYA,iDAA8B;AAE9B,gDAA6B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../ts/array/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAaA,iDAA8B;AAE9B,gDAA6B"}

package/cjs/math/Digit.d.ts

@@ -3,29 +3,29 @@ import { And } from '../predicates';
 import { IsPositive } from './IsPositive';
 import { IsWhole } from './IsWhole';
 export declare namespace Digit {
-    type ToTuple = {
+    type ToTuple<T = 1> = {
         [k in number]: any[];
     } & {
         0: [];
-        1: [1];
-        2: [1, 1];
-        3: [1, 1, 1];
-        4: [1, 1, 1, 1];
-        5: [1, 1, 1, 1, 1];
-        6: [1, 1, 1, 1, 1, 1];
-        7: [1, 1, 1, 1, 1, 1, 1];
-        8: [1, 1, 1, 1, 1, 1, 1, 1];
-        9: [1, 1, 1, 1, 1, 1, 1, 1, 1];
-        10: [1, 1, 1, 1, 1, 1, 1, 1, 1, 1];
-        11: [1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1];
-        12: [1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1];
-        13: [1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1];
-        14: [1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1];
-        15: [1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1];
-        16: [1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1];
-        17: [1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1];
-        18: [1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1];
-        19: [1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1];
+        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];
+        10: [T, T, T, T, T, T, T, T, T, T];
+        11: [T, T, T, T, T, T, T, T, T, T, T];
+        12: [T, T, T, T, T, T, T, T, T, T, T, T];
+        13: [T, T, T, T, T, T, T, T, T, T, T, T, T];
+        14: [T, T, T, T, T, T, T, T, T, T, T, T, T, T];
+        15: [T, T, T, T, T, T, T, T, T, T, T, T, T, T, T];
+        16: [T, T, T, T, T, T, T, T, T, T, T, T, T, T, T, T];
+        17: [T, T, T, T, T, T, T, T, T, T, T, T, T, T, T, T, T];
+        18: [T, T, T, T, T, T, T, T, T, T, T, T, T, T, T, T, T, T];
+        19: [T, T, T, T, T, T, T, T, T, T, T, T, T, T, T, T, T, T, T];
     };
     type GreaterThan<A extends number, B extends number> = B extends GreaterThanMap[A] ? true : false;
     type GreaterThanMap = {

package/esm/array/DropMatch.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=DropMatch.js.map

package/esm/array/DropMatch.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DropMatch.js","sourceRoot":"","sources":["../../ts/array/DropMatch.ts"],"names":[],"mappings":""}

package/esm/array/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../ts/array/index.ts"],"names":[],"mappings":"AAYA,cAAc,gBAAgB,CAAA;AAE9B,cAAc,eAAe,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../ts/array/index.ts"],"names":[],"mappings":"AAaA,cAAc,gBAAgB,CAAA;AAE9B,cAAc,eAAe,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "type-plus",
-  "version": "4.5.2",
+  "version": "4.6.0",
   "description": "Provides additional types for TypeScript.",
   "homepage": "https://github.com/unional/type-plus",
   "bugs": {

package/ts/array/CreateTuple.ts

@@ -1,4 +1,12 @@
-import { IsPositive } from '../math'
+import {
+  // Digit,
+  IsPositive
+} from '../math'
+
+// export type CreateTuple<L extends number, T = any> =
+//   number extends L ? T[] : IsPositive<L> extends true
+//   ? [...Digit.ToTuple<T>[L]]
+//   : never
 
 type BuildPowersOf2LengthArrays<N extends number, R extends never[][]> =
   R[0][N] extends never ? R : BuildPowersOf2LengthArrays<N, [[...R[0], ...R[0]], ...R]>

package/ts/array/DropMatch.spec.ts

@@ -0,0 +1,113 @@
+import { DropMatch, isType } from '..'
+
+describe('DropMatch<A, C>', () => {
+  describe('A is array', () => {
+    test('drop all types gets never[]', () => {
+      type A = DropMatch<Array<string>, string>
+      isType.equal<true, never[], A>()
+
+      type B = DropMatch<Array<string | boolean>, string | boolean>
+      isType.equal<true, never[], B>()
+    })
+
+    test('drop undefined and null from array', () => {
+      type A = DropMatch<Array<string | undefined>, undefined>
+      isType.equal<true, string[], A>()
+
+      type B = DropMatch<Array<string | number | undefined>, undefined>
+      isType.equal<true, Array<string | number>, B>()
+
+      type C = DropMatch<Array<string | number | undefined | null>, undefined | null>
+      isType.equal<true, Array<string | number>, C>()
+    })
+
+    test('can get undefined and null array when other types dropped', () => {
+      type A = DropMatch<Array<string | undefined>, string>
+      isType.equal<true, undefined[], A>()
+
+      type B = DropMatch<Array<string | number | null>, string>
+      isType.equal<true, Array<number | null>, B>()
+    })
+
+    test('unmatched criteria returns original', () => {
+      type Actual = DropMatch<Array<string | undefined>, number>
+
+      isType.equal<true, Array<string | undefined>, Actual>()
+    })
+  })
+
+  describe('A is Tuple', () => {
+    test('empty tuple', () => {
+      type A = DropMatch<[], undefined>
+      isType.equal<true, [], A>()
+
+      type B = DropMatch<[1, undefined], undefined>
+      isType.equal<true, [1], B>()
+
+      type C = DropMatch<[1, undefined, 3], undefined>
+      isType.equal<true, [1, 3], C>()
+
+      type D = DropMatch<[1, string | undefined, 3], undefined>
+      isType.equal<true, [1, string, 3], D>()
+    })
+
+    test('drop undefined from tuple', () => {
+      type A = DropMatch<[undefined], undefined>
+      isType.equal<true, [], A>()
+
+      type B = DropMatch<[1, undefined], undefined>
+      isType.equal<true, [1], B>()
+
+      type C = DropMatch<[1, undefined, 3], undefined>
+      isType.equal<true, [1, 3], C>()
+
+      type D = DropMatch<[1, string | undefined, 3], undefined>
+      isType.equal<true, [1, string, 3], D>()
+    })
+
+    test('get original if not matched', () => {
+      type A = DropMatch<[1], undefined>
+      isType.equal<true, [1], A>()
+
+      type B = DropMatch<[1], undefined | string>
+      isType.equal<true, [1], B>()
+
+      type C = DropMatch<[1, 2, 3, 4], 5>
+      isType.equal<true, [1, 2, 3, 4], C>()
+    })
+
+    test('drop narrow type', () => {
+      type C = DropMatch<[1], number>
+      isType.equal<true, [], C>()
+    })
+
+    test('keep widen type', () => {
+      type D = DropMatch<[number], 1>
+      isType.equal<true, [number], D>()
+    })
+
+    test('drop type from tuple', () => {
+      type A = DropMatch<[1], 1>
+      isType.equal<true, [], A>()
+
+      type B = DropMatch<[number | string], number>
+      isType.equal<true, [string], B>()
+
+      type C = DropMatch<[1, undefined, 3], 1>
+      isType.equal<true, [undefined, 3], C>()
+
+      type D = DropMatch<[1, string | undefined, 3], 3>
+      isType.equal<true, [1, string | undefined], D>()
+    })
+
+    test('drop multiple types', () => {
+      type Actual = DropMatch<[1, 2, 3, 4], 2 | 4>
+      isType.equal<true, [1, 3], Actual>()
+    })
+
+    test('drop undefined and null', () => {
+      type Actual = DropMatch<[1, undefined, 3, null], undefined | null>
+      isType.equal<true, [1, 3], Actual>()
+    })
+  })
+})

package/ts/array/DropMatch.ts

@@ -0,0 +1,53 @@
+import { Equal } from '../predicates'
+
+type ExcludeUnionOfEmptyTuple<A> = Equal<A, []> extends true ? A : Exclude<A, []>
+
+/**
+ * drops entries matching `Criteria` in array or tuple `A`.
+ */
+export type DropMatch<A extends Array<any>, Criteria> =
+  number extends A['length']
+  // array
+  ? (A[0] extends Criteria
+    // criteria matches: DropAll<string[], string>
+    ? never[]
+    : (undefined extends Criteria
+      ? Array<NonNullable<A[0]>>
+      // TODO: A[0] extends Criteria?
+      : (Criteria extends A[0] ? Array<Exclude<A[0], Criteria>> : A))
+  )
+  : DropMatchTuple<A, Criteria>
+
+type DropMatchTuple<A extends Array<any>, Criteria> =
+  (A['length'] extends 0
+    // empty tuple
+    ? A
+    : (A extends [infer Head, ...infer Tail]
+      ? (Tail['length'] extends 0
+        // single element tuple
+        ? (undefined extends Criteria
+          ? (Head extends Criteria
+            ? []
+            : [Head])
+          : ExcludeUnionOfEmptyTuple<(Head extends Criteria ? [] : [Head])>
+        )
+        // multiple elements
+        : (Exclude<Head, Criteria> extends never
+          ? DropMatch<Tail, Criteria>
+          : [Exclude<Head, Criteria>, ...DropMatch<Tail, Criteria>]
+        ))
+      : never[]))
+  // : (undefined extends Criteria
+  //   ? (Head extends undefined
+  //     ? DropAll<Tail, Criteria>
+  //     : [NonNullable<Head>, ...DropAll<Tail, Criteria>])
+  //   : []
+  // ))
+  // : (Head extends Criteria
+  //   ? (undefined extends Criteria
+  //     ? [1, 2, 3]// [NonNullable<Head>, ...Filter<Tail, Criteria>]
+  //     : [2, 3]// [Head, ...Filter<Tail, Criteria>]
+  //   )
+  //   : [2]//Filter<Tail, Criteria>
+  // ))
+  // : 2[]))

package/ts/array/Filter.spec.ts

@@ -1,4 +1,4 @@
-import { Filter, isType } from '..'
+import { Filter, isType, KeepMatch } from '..'
 
 describe('Filter<A, C>', () => {
   describe('A is array', () => {
@@ -52,3 +52,56 @@ describe('Filter<A, C>', () => {
     })
   })
 })
+
+describe('KeepMatch<A, C>', () => {
+  describe('A is array', () => {
+    test('array matching criteria gets itself', () => {
+      type Actual = KeepMatch<string[], string>
+      isType.equal<true, string[], Actual>()
+    })
+
+    test('array not matching criteria gets never[]', () => {
+      type Actual = KeepMatch<string[], number>
+      isType.equal<true, never[], Actual>()
+    })
+
+    test('remove unmatched type form array', () => {
+      type Actual = KeepMatch<Array<string | number>, string>
+
+      isType.equal<true, string[], Actual>()
+    })
+
+    test('remove undefined and null', () => {
+      type Actual = KeepMatch<Array<string | undefined | null>, string>
+      isType.equal<true, string[], Actual>()
+    })
+
+    test('can filter with undefined and null', () => {
+      type Actual = KeepMatch<Array<string | undefined | null>, undefined | null>
+      // Array<undefined | null> is destructured to undefined[] | null[] by TypeScript
+      isType.equal<true, undefined[] | null[], Actual>()
+    })
+
+    test('work with never[]', () => {
+      type Actual = KeepMatch<never[], undefined>
+      isType.equal<true, never[], Actual>()
+    })
+  })
+
+  describe(`A is Tuple`, () => {
+    test('matching criteria', () => {
+      type Actual = KeepMatch<[1, 2, 3, 4], 2 | 4>
+      isType.equal<true, [2, 4], Actual>()
+    })
+
+    test('no match gets never[]', () => {
+      type Actual = KeepMatch<[1, 2, 3, 4], 5>
+      isType.equal<true, never[], Actual>()
+    })
+
+    test('matching undefined and null', () => {
+      type Actual = KeepMatch<[1, undefined, 3, null], undefined | null>
+      isType.equal<true, [undefined, null], Actual>()
+    })
+  })
+})

package/ts/array/Filter.ts

@@ -1,3 +1,7 @@
+/**
+ * filter the array or tuple `A`, keeping entries satisfying `Criteria`.
+ * @deprecated renaming to `KeepMatch`
+ */
 export type Filter<A extends Array<any>, Criteria> =
   number extends A['length']
   // array
@@ -15,3 +19,8 @@ export type Filter<A extends Array<any>, Criteria> =
           ? [Head, ...Filter<Tail, Criteria>]
           : Filter<Tail, Criteria>))
       : never))
+
+/**
+ * keeps entries satisfying `Criteria` in array or tuple `A`.
+ */
+export type KeepMatch<A extends Array<any>, Criteria> = Filter<A, Criteria>

package/ts/array/index.ts

@@ -3,7 +3,8 @@ export type { Concat } from './Concat'
 export type { CreateTuple } from './CreateTuple'
 export type { DropFirst } from './DropFirst'
 export type { DropLast } from './DropLast'
-export type { Filter } from './Filter'
+export type { DropMatch } from './DropMatch'
+export type { Filter, KeepMatch } from './Filter'
 export type { FindFirst, First } from './FindFirst'
 export type { FindLast } from './FindLast'
 export type { Head } from './Head'

package/ts/math/Digit.ts

@@ -4,29 +4,29 @@ import { IsPositive } from './IsPositive'
 import { IsWhole } from './IsWhole'
 
 export namespace Digit {
-  export type ToTuple = {
+  export type ToTuple<T = 1> = {
     [k in number]: any[]
   } & {
     0: [],
-    1: [1],
-    2: [1, 1],
-    3: [1, 1, 1],
-    4: [1, 1, 1, 1],
-    5: [1, 1, 1, 1, 1],
-    6: [1, 1, 1, 1, 1, 1],
-    7: [1, 1, 1, 1, 1, 1, 1],
-    8: [1, 1, 1, 1, 1, 1, 1, 1],
-    9: [1, 1, 1, 1, 1, 1, 1, 1, 1],
-    10: [1, 1, 1, 1, 1, 1, 1, 1, 1, 1],
-    11: [1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1],
-    12: [1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1],
-    13: [1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1],
-    14: [1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1],
-    15: [1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1],
-    16: [1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1],
-    17: [1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1],
-    18: [1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1],
-    19: [1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1],
+    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],
+    10: [T, T, T, T, T, T, T, T, T, T],
+    11: [T, T, T, T, T, T, T, T, T, T, T],
+    12: [T, T, T, T, T, T, T, T, T, T, T, T],
+    13: [T, T, T, T, T, T, T, T, T, T, T, T, T],
+    14: [T, T, T, T, T, T, T, T, T, T, T, T, T, T],
+    15: [T, T, T, T, T, T, T, T, T, T, T, T, T, T, T],
+    16: [T, T, T, T, T, T, T, T, T, T, T, T, T, T, T, T],
+    17: [T, T, T, T, T, T, T, T, T, T, T, T, T, T, T, T, T],
+    18: [T, T, T, T, T, T, T, T, T, T, T, T, T, T, T, T, T, T],
+    19: [T, T, T, T, T, T, T, T, T, T, T, T, T, T, T, T, T, T, T],
   }
 
   /**