type-plus 4.6.3 → 4.7.0

package/README.md

@@ -440,6 +440,7 @@ So you may encounter some weird behavior if your logic is complex.
 - `requiredDeep(...)`: merge options deeply and removing `Partial<T>`. From [`unpartial`](https://github.com/unional/unpartial)
 - `split(target, ...splitters)`: split one object into multiple objects.
 - `stub<T>(value)`: stub a particular type `T`.
+- `stub.build<T>(init?)`: build a stub for particular type `T`.
 - `typeOverrideIncompatible<T>()`: override only the incompatible portion between two types.
 
 ```ts

package/cjs/testing/stub.d.ts

@@ -4,3 +4,6 @@ export declare namespace stub {
     type Param<T> = T extends AnyFunction ? T : RecursivePartial<T>;
 }
 export declare function stub<T>(stub?: stub.Param<T>): T;
+export declare namespace stub {
+    var build: <T>(init?: Param<T> | undefined) => (value?: Param<T> | undefined) => T;
+}

package/cjs/testing/stub.js

@@ -1,8 +1,16 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.stub = void 0;
+var unpartial_1 = require("unpartial");
 function stub(stub) {
     return stub;
 }
 exports.stub = stub;
+stub.build = function build(init) {
+    return function (value) {
+        return init
+            ? stub((0, unpartial_1.requiredDeep)(init, value))
+            : stub(value);
+    };
+};
 //# sourceMappingURL=stub.js.map

package/cjs/testing/stub.js.map

@@ -1 +1 @@
-{"version":3,"file":"stub.js","sourceRoot":"","sources":["../../ts/testing/stub.ts"],"names":[],"mappings":";;;AAOA,SAAgB,IAAI,CAAI,IAAoB;IAC1C,OAAO,IAAS,CAAA;AAClB,CAAC;AAFD,oBAEC"}
+{"version":3,"file":"stub.js","sourceRoot":"","sources":["../../ts/testing/stub.ts"],"names":[],"mappings":";;;AAAA,uCAAwC;AAQxC,SAAgB,IAAI,CAAI,IAAoB;IAC1C,OAAO,IAAS,CAAA;AAClB,CAAC;AAFD,oBAEC;AAKD,IAAI,CAAC,KAAK,GAAG,SAAS,KAAK,CAAI,IAAoB;IACjD,OAAO,UAAU,KAAqB;QACpC,OAAO,IAAI;YACT,CAAC,CAAC,IAAI,CAAI,IAAA,wBAAY,EAAC,IAAW,EAAE,KAAY,CAAQ,CAAC;YACzD,CAAC,CAAC,IAAI,CAAI,KAAK,CAAC,CAAA;IACpB,CAAC,CAAA;AACH,CAAC,CAAA"}

package/esm/testing/stub.js

@@ -1,4 +1,12 @@
+import { requiredDeep } from 'unpartial';
 export function stub(stub) {
     return stub;
 }
+stub.build = function build(init) {
+    return function (value) {
+        return init
+            ? stub(requiredDeep(init, value))
+            : stub(value);
+    };
+};
 //# sourceMappingURL=stub.js.map

package/esm/testing/stub.js.map

@@ -1 +1 @@
-{"version":3,"file":"stub.js","sourceRoot":"","sources":["../../ts/testing/stub.ts"],"names":[],"mappings":"AAOA,MAAM,UAAU,IAAI,CAAI,IAAoB;IAC1C,OAAO,IAAS,CAAA;AAClB,CAAC"}
+{"version":3,"file":"stub.js","sourceRoot":"","sources":["../../ts/testing/stub.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAA;AAQxC,MAAM,UAAU,IAAI,CAAI,IAAoB;IAC1C,OAAO,IAAS,CAAA;AAClB,CAAC;AAKD,IAAI,CAAC,KAAK,GAAG,SAAS,KAAK,CAAI,IAAoB;IACjD,OAAO,UAAU,KAAqB;QACpC,OAAO,IAAI;YACT,CAAC,CAAC,IAAI,CAAI,YAAY,CAAC,IAAW,EAAE,KAAY,CAAQ,CAAC;YACzD,CAAC,CAAC,IAAI,CAAI,KAAK,CAAC,CAAA;IACpB,CAAC,CAAA;AACH,CAAC,CAAA"}

package/package.json

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

package/ts/testing/stub.spec.ts

@@ -1,38 +1,58 @@
 import { isType, stub } from '..'
 
-test('stub is a partial of the actual object', () => {
-  const real = { a: 1, b: { c: 2 }, d: 3 }
+describe('stub()', () => {
+  test('stub is a partial of the actual object', () => {
+    const real = { a: 1, b: { c: 2 }, d: 3 }
 
-  const a = stub<typeof real>({ a: 2 })
-  expect(a.a).toBe(2)
-  isType.equal<true, typeof a, typeof real>()
-})
+    const a = stub<typeof real>({ a: 2 })
+    expect(a.a).toBe(2)
+    isType.equal<true, typeof a, typeof real>()
+  })
+
+  test('stub function retains param types', () => {
+    function real(a: string, b: number): boolean { return a === String(b) }
 
-test('stub function retains param types', () => {
-  function real(a: string, b: number): boolean { return a === String(b) }
+    const a = stub<typeof real>((_a, _b) => {
+      isType.equal<true, string, typeof _a>()
+      isType.equal<true, number, typeof _b>()
+      return false
+    })
 
-  const a = stub<typeof real>((_a, _b) => {
-    isType.equal<true, string, typeof _a>()
-    isType.equal<true, number, typeof _b>()
-    return false
+    expect(a('1', 1)).toBe(false)
+    isType.equal<true, typeof a, typeof real>()
   })
 
-  expect(a('1', 1)).toBe(false)
-  isType.equal<true, typeof a, typeof real>()
-})
+  test('stub function params can be omitted', () => {
+    function real(a: string, b: number): boolean { return a === String(b) }
 
-test('stub function params can be omitted', () => {
-  function real(a: string, b: number): boolean { return a === String(b) }
+    const a = stub<typeof real>(() => false)
 
-  const a = stub<typeof real>(() => false)
+    expect(a('1', 1)).toBe(false)
+    isType.equal<true, typeof a, typeof real>()
+  })
 
-  expect(a('1', 1)).toBe(false)
-  isType.equal<true, typeof a, typeof real>()
+  test('stub input can be omitted', () => {
+    const real = { a: 1, b: { c: 2 }, d: 3 }
+
+    const a = stub<typeof real>()
+    isType.equal<true, typeof a, typeof real>()
+  })
 })
 
-test('stub input can be omitted', () => {
-  const real = { a: 1, b: { c: 2 }, d: 3 }
+describe('stub.build()', () => {
+  test('build a stub function', () => {
+    const real = { a: 1, b: { c: 2 }, d: 3 }
 
-  const a = stub<typeof real>()
-  isType.equal<true, typeof a, typeof real>()
+    const s = stub.build<typeof real>()
+    const a = s({ a: 2 })
+    expect(a.a).toBe(2)
+    isType.equal<true, typeof a, typeof real>()
+  })
+  test('can define init value', () => {
+    type S = { a: number, b: string }
+    const s = stub.build<S>({ b: 'b' })
+    const a = s({ a: 1 })
+    expect(a).toEqual({ a: 1, b: 'b' })
+    isType.equal<true, S, typeof a>()
+  })
 })

package/ts/testing/stub.ts

@@ -1,3 +1,4 @@
+import { requiredDeep } from 'unpartial'
 import { AnyFunction } from '../function'
 import { RecursivePartial } from '../object'
 
@@ -8,3 +9,14 @@ export namespace stub {
 export function stub<T>(stub?: stub.Param<T>) {
   return stub as T
 }
+
+/**
+ * builds a stub function
+ */
+stub.build = function build<T>(init?: stub.Param<T>) {
+  return function (value?: stub.Param<T>) {
+    return init
+      ? stub<T>(requiredDeep(init as any, value as any) as any)
+      : stub<T>(value)
+  }
+}