type-plus 4.3.2 → 4.4.2

package/README.md

@@ -432,6 +432,7 @@ So you may encounter some weird behavior if your logic is complex.
 - `required(...)`: merge options and removing `Partial<T>`. From [`unpartial`](https://github.com/unional/unpartial)
 - `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`.
 - `typeOverrideIncompatible<T>()`: override only the incompatible portion between two types.
 
 ```ts

package/cjs/index.d.ts

@@ -13,5 +13,6 @@ export * from './object';
 export * from './predicates';
 export type { PrimitiveTypes } from './PrimitiveTypes';
 export * from './promise';
+export * from './testing';
 export type { UnionKeys } from './UnionKeys';
 export * from './utils';

package/cjs/index.js

@@ -31,6 +31,7 @@ __exportStar(require("./nominal-types"), exports);
 __exportStar(require("./object"), exports);
 __exportStar(require("./predicates"), exports);
 __exportStar(require("./promise"), exports);
+__exportStar(require("./testing"), exports);
 __exportStar(require("./utils"), exports);
 // export { types, types as T }
 //# sourceMappingURL=index.js.map

package/cjs/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../ts/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,mCAAmC;AACnC,uCAAkD;AAAzC,qGAAA,QAAQ,OAAA;AAAE,yGAAA,YAAY,OAAA;AAC/B,0CAAuB;AACvB,8CAA2B;AAC3B,0CAAuB;AAEvB,6CAA0B;AAC1B,+CAA4B;AAC5B,8CAA2B;AAC3B,yCAAsB;AACtB,2CAAwB;AACxB,kDAA+B;AAC/B,2CAAwB;AACxB,+CAA4B;AAE5B,4CAAyB;AAIzB,0CAAuB;AACvB,+BAA+B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../ts/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,mCAAmC;AACnC,uCAAkD;AAAzC,qGAAA,QAAQ,OAAA;AAAE,yGAAA,YAAY,OAAA;AAC/B,0CAAuB;AACvB,8CAA2B;AAC3B,0CAAuB;AAEvB,6CAA0B;AAC1B,+CAA4B;AAC5B,8CAA2B;AAC3B,yCAAsB;AACtB,2CAAwB;AACxB,kDAA+B;AAC/B,2CAAwB;AACxB,+CAA4B;AAE5B,4CAAyB;AACzB,4CAAyB;AAIzB,0CAAuB;AACvB,+BAA+B"}

package/cjs/testing/index.d.ts

@@ -0,0 +1 @@
+export * from './stub';

package/cjs/testing/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./stub"), exports);
+//# sourceMappingURL=index.js.map

package/cjs/testing/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../ts/testing/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,yCAAsB"}

package/cjs/testing/stub.d.ts

@@ -0,0 +1,6 @@
+import { AnyFunction } from '../function';
+import { RecursivePartial } from '../object';
+export declare namespace stub {
+    type Param<T> = T extends AnyFunction ? T : RecursivePartial<T>;
+}
+export declare function stub<T>(stub?: stub.Param<T>): T;

package/cjs/testing/stub.js

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

package/cjs/testing/stub.js.map

@@ -0,0 +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"}

package/esm/index.js

@@ -12,6 +12,7 @@ export * from './nominal-types';
 export * from './object';
 export * from './predicates';
 export * from './promise';
+export * from './testing';
 export * from './utils';
 // export { types, types as T }
 //# sourceMappingURL=index.js.map

package/esm/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../ts/index.ts"],"names":[],"mappings":"AAAA,mCAAmC;AACnC,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,MAAM,WAAW,CAAA;AAClD,cAAc,SAAS,CAAA;AACvB,cAAc,aAAa,CAAA;AAC3B,cAAc,SAAS,CAAA;AAEvB,cAAc,YAAY,CAAA;AAC1B,cAAc,cAAc,CAAA;AAC5B,cAAc,aAAa,CAAA;AAC3B,cAAc,QAAQ,CAAA;AACtB,cAAc,UAAU,CAAA;AACxB,cAAc,iBAAiB,CAAA;AAC/B,cAAc,UAAU,CAAA;AACxB,cAAc,cAAc,CAAA;AAE5B,cAAc,WAAW,CAAA;AAIzB,cAAc,SAAS,CAAA;AACvB,+BAA+B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../ts/index.ts"],"names":[],"mappings":"AAAA,mCAAmC;AACnC,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,MAAM,WAAW,CAAA;AAClD,cAAc,SAAS,CAAA;AACvB,cAAc,aAAa,CAAA;AAC3B,cAAc,SAAS,CAAA;AAEvB,cAAc,YAAY,CAAA;AAC1B,cAAc,cAAc,CAAA;AAC5B,cAAc,aAAa,CAAA;AAC3B,cAAc,QAAQ,CAAA;AACtB,cAAc,UAAU,CAAA;AACxB,cAAc,iBAAiB,CAAA;AAC/B,cAAc,UAAU,CAAA;AACxB,cAAc,cAAc,CAAA;AAE5B,cAAc,WAAW,CAAA;AACzB,cAAc,WAAW,CAAA;AAIzB,cAAc,SAAS,CAAA;AACvB,+BAA+B"}

package/esm/testing/index.js

@@ -0,0 +1,2 @@
+export * from './stub';
+//# sourceMappingURL=index.js.map

package/esm/testing/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../ts/testing/index.ts"],"names":[],"mappings":"AAAA,cAAc,QAAQ,CAAA"}

package/esm/testing/stub.js

@@ -0,0 +1,4 @@
+export function stub(stub) {
+    return stub;
+}
+//# sourceMappingURL=stub.js.map

package/esm/testing/stub.js.map

@@ -0,0 +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"}

package/package.json

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

package/ts/index.ts

@@ -14,6 +14,7 @@ export * from './object'
 export * from './predicates'
 export type { PrimitiveTypes } from './PrimitiveTypes'
 export * from './promise'
+export * from './testing'
 // export * from './types/optional'
 // export * from './types/required'
 export type { UnionKeys } from './UnionKeys'

package/ts/testing/index.ts

@@ -0,0 +1 @@
+export * from './stub'

package/ts/testing/stub.spec.ts

@@ -0,0 +1,38 @@
+import { isType, stub } from '..'
+
+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>()
+})
+
+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
+  })
+
+  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) }
+
+  const a = stub<typeof real>(() => false)
+
+  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>()
+})

package/ts/testing/stub.ts

@@ -0,0 +1,10 @@
+import { AnyFunction } from '../function'
+import { RecursivePartial } from '../object'
+
+export namespace stub {
+  export type Param<T> = T extends AnyFunction ? T : RecursivePartial<T>
+}
+
+export function stub<T>(stub?: stub.Param<T>) {
+  return stub as T
+}