type-plus 4.7.0 → 4.8.2

package/README.md

@@ -427,6 +427,7 @@ So you may encounter some weird behavior if your logic is complex.
 
 ### Utility Functions
 
+- `amend(subject)...`: amend subject as union or intersect of `T`.
 - `facade(subject, ...props)`: create a facade of `subject`.
 - `getField(subject, key, defaultValue)`: get a field from a subject. Works against nullable and optional subject.
 - `hasKey()`: function of `HasKey`.

package/cjs/math/GreaterThan.d.ts

@@ -7,5 +7,5 @@ import type { Max } from './Max';
 export declare type GreaterThan<A extends number, B extends number, Fail = never> = And<And<IsPositive<A>, IsWhole<A>>, And<IsPositive<B>, IsWhole<B>>> extends false ? Fail : number extends A ? Fail : number extends B ? Fail : Equal<A, B> extends true ? false : GreaterThan.OnPositiveWhole<A, B>;
 export declare namespace GreaterThan {
     type OnPositiveWhole<A extends number, B extends number> = (DigitArray.FromNumber<A> extends infer DA ? DA extends number[] ? DigitArray.FromNumber<B> extends infer DB ? DB extends number[] ? Max<DA['length'], DB['length']> extends infer M ? M extends number ? PadLeft<DA, M, 0> extends infer PDA ? PDA extends number[] ? PadLeft<DB, M, 0> extends infer PDB ? PDB extends number[] ? OnDigitArray<PDA, PDB> : never : never : never : never : never : never : never : never : never : never);
-    type OnDigitArray<DA extends number[], DB extends number[]> = (Equal<Head<DA>, Head<DB>> extends true ? OnDigitArray<Tail<DA>, Tail<DB>> extends Tail<DA> ? true : false : Digit.GreaterThan<Head<DA>, Head<DB>> extends true ? true : false);
+    type OnDigitArray<DA extends number[], DB extends number[]> = (Equal<Head<DA>, Head<DB>> extends true ? OnDigitArray<Tail<DA>, Tail<DB>> : Digit.GreaterThan<Head<DA>, Head<DB>>);
 }

package/cjs/object/split.d.ts

@@ -4,7 +4,7 @@ declare type Splitter<T extends AnyRecord> = Partial<{
     [k in keyof T]: T[k] | undefined;
 }>;
 export declare type Split<T extends AnyRecord, S extends AnyRecord> = {
-    [k in keyof S]: S[k] extends undefined ? T[k] : NonNullable<T[k]> | S[k];
+    [k in keyof S]-?: S[k] extends undefined ? T[k] : NonNullable<T[k]> | S[k];
 };
 export declare function split<T extends AnyRecord, S1 extends Splitter<T>>(target: T, split1: S1): [
     Split<T, S1>,

package/cjs/utils/as.d.ts

@@ -1,2 +1,6 @@
 export declare function as<T>(subject: unknown): T;
 export declare function asAny(subject: unknown): any;
+export declare function amend<S>(subject: S): {
+    union<T>(): T & S;
+    intersect<T_1>(): S | T_1;
+};

package/cjs/utils/as.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.asAny = exports.as = void 0;
+exports.amend = exports.asAny = exports.as = void 0;
 function as(subject) {
     return subject;
 }
@@ -9,4 +9,11 @@ function asAny(subject) {
     return subject;
 }
 exports.asAny = asAny;
+function amend(subject) {
+    return {
+        union: function () { return subject; },
+        intersect: function () { return subject; }
+    };
+}
+exports.amend = amend;
 //# sourceMappingURL=as.js.map

package/cjs/utils/as.js.map

@@ -1 +1 @@
-{"version":3,"file":"as.js","sourceRoot":"","sources":["../../ts/utils/as.ts"],"names":[],"mappings":";;;AAAA,SAAgB,EAAE,CAAI,OAAgB;IACpC,OAAO,OAAY,CAAA;AACrB,CAAC;AAFD,gBAEC;AAED,SAAgB,KAAK,CAAC,OAAgB;IACpC,OAAO,OAAO,CAAA;AAChB,CAAC;AAFD,sBAEC"}
+{"version":3,"file":"as.js","sourceRoot":"","sources":["../../ts/utils/as.ts"],"names":[],"mappings":";;;AAAA,SAAgB,EAAE,CAAI,OAAgB;IACpC,OAAO,OAAY,CAAA;AACrB,CAAC;AAFD,gBAEC;AAED,SAAgB,KAAK,CAAC,OAAgB;IACpC,OAAO,OAAO,CAAA;AAChB,CAAC;AAFD,sBAEC;AAKD,SAAgB,KAAK,CAAI,OAAU;IACjC,OAAO;QACL,KAAK,EAAL,cAAoB,OAAO,OAAgB,CAAA,CAAC,CAAC;QAC7C,SAAS,EAAT,cAAwB,OAAO,OAAgB,CAAA,CAAC,CAAC;KAClD,CAAA;AACH,CAAC;AALD,sBAKC"}

package/esm/utils/as.js

@@ -4,4 +4,10 @@ export function as(subject) {
 export function asAny(subject) {
     return subject;
 }
+export function amend(subject) {
+    return {
+        union() { return subject; },
+        intersect() { return subject; }
+    };
+}
 //# sourceMappingURL=as.js.map

package/esm/utils/as.js.map

@@ -1 +1 @@
-{"version":3,"file":"as.js","sourceRoot":"","sources":["../../ts/utils/as.ts"],"names":[],"mappings":"AAAA,MAAM,UAAU,EAAE,CAAI,OAAgB;IACpC,OAAO,OAAY,CAAA;AACrB,CAAC;AAED,MAAM,UAAU,KAAK,CAAC,OAAgB;IACpC,OAAO,OAAO,CAAA;AAChB,CAAC"}
+{"version":3,"file":"as.js","sourceRoot":"","sources":["../../ts/utils/as.ts"],"names":[],"mappings":"AAAA,MAAM,UAAU,EAAE,CAAI,OAAgB;IACpC,OAAO,OAAY,CAAA;AACrB,CAAC;AAED,MAAM,UAAU,KAAK,CAAC,OAAgB;IACpC,OAAO,OAAO,CAAA;AAChB,CAAC;AAKD,MAAM,UAAU,KAAK,CAAI,OAAU;IACjC,OAAO;QACL,KAAK,KAAe,OAAO,OAAgB,CAAA,CAAC,CAAC;QAC7C,SAAS,KAAe,OAAO,OAAgB,CAAA,CAAC,CAAC;KAClD,CAAA;AACH,CAAC"}

package/package.json

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

package/ts/math/GreaterThan.spec.ts

@@ -1,40 +1,43 @@
-import { GreaterThan, isType } from '..'
-
-test('only support positive and whole number', () => {
-  isType.equal<true, never, GreaterThan<0.1, 1>>()
-  isType.equal<true, never, GreaterThan<-1, 1>>()
-  isType.equal<true, never, GreaterThan<1, 0.1>>()
-  isType.equal<true, never, GreaterThan<1, -1>>()
-})
-
-test('number gets never', () => {
-  isType.equal<true, never, GreaterThan<number, 1>>()
-  isType.equal<true, never, GreaterThan<1, number>>()
-})
-
-test('override Fail case', () => {
-  isType.equal<true, number, GreaterThan<number, 1, number>>()
-})
-
-test('n > n is false', () => {
-  isType.f<GreaterThan<0, 0>>()
-  isType.f<GreaterThan<1, 1>>()
-  isType.f<GreaterThan<12, 12>>()
-})
-
-test('with same number of digits', () => {
-  isType.t<GreaterThan<1, 0>>()
-  isType.t<GreaterThan<22, 11>>()
-  isType.t<GreaterThan<20, 19>>()
-
-  isType.f<GreaterThan<0, 1>>()
-  isType.f<GreaterThan<11, 22>>()
-  isType.f<GreaterThan<19, 20>>()
-})
-
-test('with different number of digits', () => {
-  isType.f<GreaterThan<0, 1>>()
-  isType.f<GreaterThan<9, 100>>()
-  isType.t<GreaterThan<10, 1>>()
-  isType.t<GreaterThan<123, 32>>()
-})
+import { GreaterThan, isType } from '..'
+
+test('only support positive and whole number', () => {
+  isType.equal<true, never, GreaterThan<0.1, 1>>()
+  isType.equal<true, never, GreaterThan<-1, 1>>()
+  isType.equal<true, never, GreaterThan<1, 0.1>>()
+  isType.equal<true, never, GreaterThan<1, -1>>()
+})
+
+test('number gets never', () => {
+  isType.equal<true, never, GreaterThan<number, 1>>()
+  isType.equal<true, never, GreaterThan<1, number>>()
+})
+
+test('override Fail case', () => {
+  isType.equal<true, number, GreaterThan<number, 1, number>>()
+})
+
+test('n > n is false', () => {
+  isType.f<GreaterThan<0, 0>>()
+  isType.f<GreaterThan<1, 1>>()
+  isType.f<GreaterThan<12, 12>>()
+})
+
+test('with same number of digits', () => {
+  isType.t<GreaterThan<1, 0>>()
+  isType.t<GreaterThan<22, 11>>()
+  isType.t<GreaterThan<20, 19>>()
+  isType.t<GreaterThan<19, 10>>()
+
+  isType.f<GreaterThan<0, 1>>()
+  isType.f<GreaterThan<11, 22>>()
+  isType.f<GreaterThan<19, 20>>()
+  isType.f<GreaterThan<10, 19>>()
+})
+
+test('with different number of digits', () => {
+  isType.f<GreaterThan<0, 1>>()
+  isType.f<GreaterThan<9, 100>>()
+  isType.t<GreaterThan<10, 1>>()
+  isType.t<GreaterThan<123, 32>>()
+  isType.t<GreaterThan<123, 13>>()
+})

package/ts/math/GreaterThan.ts

@@ -31,8 +31,8 @@ export namespace GreaterThan {
   )
 
   export type OnDigitArray<DA extends number[], DB extends number[]> = (
-    Equal<Head<DA>, Head<DB>> extends true ?
-    OnDigitArray<Tail<DA>, Tail<DB>> extends Tail<DA> ? true : false :
-    Digit.GreaterThan<Head<DA>, Head<DB>> extends true ? true : false
+    Equal<Head<DA>, Head<DB>> extends true
+    ? OnDigitArray<Tail<DA>, Tail<DB>>
+    : Digit.GreaterThan<Head<DA>, Head<DB>>
   )
 }

package/ts/object/split.spec.ts

@@ -35,6 +35,24 @@ test('can default with null', () => {
   isType.equal<true, number | null, typeof a>()
 })
 
+test('remove optional/undefined when default is provided', () => {
+  interface S {
+    variant?: 'abc' | 'def'
+  }
+  const s: S = {}
+  const [a] = split(s, { variant: 'def' })
+  isType.equal<true, 'abc' | 'def', typeof a.variant>()
+})
+
+test('keep undefined when default is undefined', () => {
+  interface S {
+    variant?: 'abc' | 'def'
+  }
+  const s: S = {}
+  const [a] = split(s, { variant: undefined })
+  isType.equal<true, 'abc' | 'def' | undefined, typeof a.variant>()
+})
+
 
 test('can default with false', () => {
   const s: { a?: number | boolean } = {}

package/ts/object/split.ts

@@ -4,7 +4,7 @@ import { reduceByKey } from './reduceKey'
 
 type Splitter<T extends AnyRecord> = Partial<{ [k in keyof T]: T[k] | undefined }>
 export type Split<T extends AnyRecord, S extends AnyRecord> = {
-  [k in keyof S]: S[k] extends undefined ? T[k] : NonNullable<T[k]> | S[k]
+  [k in keyof S]-?: S[k] extends undefined ? T[k] : NonNullable<T[k]> | S[k]
 }
 
 /**

package/ts/utils/as.spec.ts

@@ -1,4 +1,4 @@
-import { as, asAny, isType } from '..'
+import { amend, as, asAny, isType } from '..'
 
 describe('as<T>()', () => {
   test('defaults subject type to unknown', () => {
@@ -31,3 +31,15 @@ describe('asAny()', () => {
   })
 })
 
+describe('amend<T>()', () => {
+  test('assert subject as (subject & T)', () => {
+    const s = { a: 1 }
+    const a = amend(s).union<{ b: string }>()
+    isType.equal<true, { a: number } & { b: string }, typeof a>()
+  })
+  test('assert subject as (subject | T)', () => {
+    const s = { a: 1 }
+    const a = amend(s).intersect<{ b: string }>()
+    isType.equal<true, { a: number } | { b: string }, typeof a>()
+  })
+})

package/ts/utils/as.ts

@@ -5,3 +5,13 @@ export function as<T>(subject: unknown): T {
 export function asAny(subject: unknown): any {
   return subject
 }
+
+/**
+ * amend `subject` with type `T`
+ */
+export function amend<S>(subject: S) {
+  return {
+    union<T>(): T & S { return subject as T & S },
+    intersect<T>(): T | S { return subject as T | S }
+  }
+}