type-plus 4.7.0 → 4.8.0

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/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.0",
   "description": "Provides additional types for TypeScript.",
   "homepage": "https://github.com/unional/type-plus",
   "bugs": {

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 }
+  }
+}