type-plus 5.5.1 → 5.5.2

package/README.md

@@ -558,7 +558,8 @@ nominalMatch(b1, b2) // false
 - `AnyFunction<P, R>`: a generic type for any function
 - `ExtractFunction<F>`: extract the function signature from a type `F`.
 - `extractFunction(fn: F)`: adjust type of `fn` to its function signature only.
-- `inspect<T>(value: T, inspector: (v: T) => void)`: inspect a value and return it.
+- `inspect<T>(value: T, inspector?: (v: T) => void)`: inspect a value and return it.\
+  Inspector defaults to `console.dir()`
 
 ## Functional Types
 

package/cjs/utils/inspect.d.ts

@@ -1,5 +1,5 @@
 /**
  * Inspects the value and returns it.
  */
-export declare function inspect<T>(value: T, inspector: (value: Readonly<T>) => void): T;
+export declare function inspect<T>(value: T, inspector?: (value: Readonly<T>) => void): T;
 //# sourceMappingURL=inspect.d.ts.map

package/cjs/utils/inspect.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"inspect.d.ts","sourceRoot":"","sources":["../../ts/utils/inspect.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,wBAAgB,OAAO,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,SAAS,EAAE,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC,CAAC,KAAK,IAAI,GAAG,CAAC,CAG/E"}
+{"version":3,"file":"inspect.d.ts","sourceRoot":"","sources":["../../ts/utils/inspect.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,wBAAgB,OAAO,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,SAAS,GAAE,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC,CAAC,KAAK,IAAkB,GAAG,CAAC,CAG7F"}

package/cjs/utils/inspect.js

@@ -1,10 +1,12 @@
 "use strict";
+/* eslint-disable no-console */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.inspect = void 0;
 /**
  * Inspects the value and returns it.
  */
 function inspect(value, inspector) {
+    if (inspector === void 0) { inspector = console.dir; }
     inspector(value);
     return value;
 }

package/cjs/utils/inspect.js.map

@@ -1 +1 @@
-{"version":3,"file":"inspect.js","sourceRoot":"","sources":["../../ts/utils/inspect.ts"],"names":[],"mappings":";;;AAAA;;GAEG;AACH,SAAgB,OAAO,CAAI,KAAQ,EAAE,SAAuC;IAC1E,SAAS,CAAC,KAAK,CAAC,CAAA;IAChB,OAAO,KAAK,CAAA;AACd,CAAC;AAHD,0BAGC"}
+{"version":3,"file":"inspect.js","sourceRoot":"","sources":["../../ts/utils/inspect.ts"],"names":[],"mappings":";AAAA,+BAA+B;;;AAE/B;;GAEG;AACH,SAAgB,OAAO,CAAI,KAAQ,EAAE,SAAqD;IAArD,0BAAA,EAAA,YAA0C,OAAO,CAAC,GAAG;IACxF,SAAS,CAAC,KAAK,CAAC,CAAA;IAChB,OAAO,KAAK,CAAA;AACd,CAAC;AAHD,0BAGC"}

package/cjs/utils/inspect.spec.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+/* eslint-disable no-console */
 var globals_1 = require("@jest/globals");
 var index_js_1 = require("./index.js");
 describe("".concat(index_js_1.inspect.name, "()"), function () {
@@ -13,5 +14,13 @@ describe("".concat(index_js_1.inspect.name, "()"), function () {
         (0, index_js_1.inspect)(value, spy);
         expect(spy).toBeCalledWith(value);
     });
+    it('defaults to console.dir', function () {
+        var value = { a: 1, b: 2 };
+        var dir = console.dir;
+        console.dir = globals_1.jest.fn();
+        (0, index_js_1.inspect)(value);
+        expect(console.dir).toBeCalledWith(value);
+        console.dir = dir;
+    });
 });
 //# sourceMappingURL=inspect.spec.js.map

package/cjs/utils/inspect.spec.js.map

@@ -1 +1 @@
-{"version":3,"file":"inspect.spec.js","sourceRoot":"","sources":["../../ts/utils/inspect.spec.ts"],"names":[],"mappings":";;AAAA,yCAAoC;AACpC,uCAAoC;AAEpC,QAAQ,CAAC,UAAG,kBAAO,CAAC,IAAI,OAAI,EAAE;IAC5B,EAAE,CAAC,8BAA8B,EAAE;QACjC,IAAM,KAAK,GAAG,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAA;QAC5B,MAAM,CAAC,IAAA,kBAAO,EAAC,KAAK,EAAE,cAAQ,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;IAC/C,CAAC,CAAC,CAAA;IACF,EAAE,CAAC,2BAA2B,EAAE;QAC9B,IAAM,KAAK,GAAG,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAA;QAC5B,IAAM,GAAG,GAAG,cAAI,CAAC,EAAE,EAAE,CAAA;QACrB,IAAA,kBAAO,EAAC,KAAK,EAAE,GAAG,CAAC,CAAA;QACnB,MAAM,CAAC,GAAG,CAAC,CAAC,cAAc,CAAC,KAAK,CAAC,CAAA;IACnC,CAAC,CAAC,CAAA;AACJ,CAAC,CAAC,CAAA"}
+{"version":3,"file":"inspect.spec.js","sourceRoot":"","sources":["../../ts/utils/inspect.spec.ts"],"names":[],"mappings":";;AAAA,+BAA+B;AAC/B,yCAAoC;AACpC,uCAAoC;AAEpC,QAAQ,CAAC,UAAG,kBAAO,CAAC,IAAI,OAAI,EAAE;IAC5B,EAAE,CAAC,8BAA8B,EAAE;QACjC,IAAM,KAAK,GAAG,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAA;QAC5B,MAAM,CAAC,IAAA,kBAAO,EAAC,KAAK,EAAE,cAAQ,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;IAC/C,CAAC,CAAC,CAAA;IACF,EAAE,CAAC,2BAA2B,EAAE;QAC9B,IAAM,KAAK,GAAG,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAA;QAC5B,IAAM,GAAG,GAAG,cAAI,CAAC,EAAE,EAAE,CAAA;QACrB,IAAA,kBAAO,EAAC,KAAK,EAAE,GAAG,CAAC,CAAA;QACnB,MAAM,CAAC,GAAG,CAAC,CAAC,cAAc,CAAC,KAAK,CAAC,CAAA;IACnC,CAAC,CAAC,CAAA;IACF,EAAE,CAAC,yBAAyB,EAAE;QAC5B,IAAM,KAAK,GAAG,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAA;QAC5B,IAAM,GAAG,GAAG,OAAO,CAAC,GAAG,CAAA;QACvB,OAAO,CAAC,GAAG,GAAG,cAAI,CAAC,EAAE,EAAE,CAAA;QACvB,IAAA,kBAAO,EAAC,KAAK,CAAC,CAAA;QACd,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,cAAc,CAAC,KAAK,CAAC,CAAA;QACzC,OAAO,CAAC,GAAG,GAAG,GAAG,CAAA;IACnB,CAAC,CAAC,CAAA;AACJ,CAAC,CAAC,CAAA"}

package/esm/utils/inspect.d.ts

@@ -1,5 +1,5 @@
 /**
  * Inspects the value and returns it.
  */
-export declare function inspect<T>(value: T, inspector: (value: Readonly<T>) => void): T;
+export declare function inspect<T>(value: T, inspector?: (value: Readonly<T>) => void): T;
 //# sourceMappingURL=inspect.d.ts.map

package/esm/utils/inspect.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"inspect.d.ts","sourceRoot":"","sources":["../../ts/utils/inspect.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,wBAAgB,OAAO,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,SAAS,EAAE,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC,CAAC,KAAK,IAAI,GAAG,CAAC,CAG/E"}
+{"version":3,"file":"inspect.d.ts","sourceRoot":"","sources":["../../ts/utils/inspect.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,wBAAgB,OAAO,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,SAAS,GAAE,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC,CAAC,KAAK,IAAkB,GAAG,CAAC,CAG7F"}

package/esm/utils/inspect.js

@@ -1,7 +1,8 @@
+/* eslint-disable no-console */
 /**
  * Inspects the value and returns it.
  */
-export function inspect(value, inspector) {
+export function inspect(value, inspector = console.dir) {
     inspector(value);
     return value;
 }

package/esm/utils/inspect.js.map

@@ -1 +1 @@
-{"version":3,"file":"inspect.js","sourceRoot":"","sources":["../../ts/utils/inspect.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,UAAU,OAAO,CAAI,KAAQ,EAAE,SAAuC;IAC1E,SAAS,CAAC,KAAK,CAAC,CAAA;IAChB,OAAO,KAAK,CAAA;AACd,CAAC"}
+{"version":3,"file":"inspect.js","sourceRoot":"","sources":["../../ts/utils/inspect.ts"],"names":[],"mappings":"AAAA,+BAA+B;AAE/B;;GAEG;AACH,MAAM,UAAU,OAAO,CAAI,KAAQ,EAAE,YAA0C,OAAO,CAAC,GAAG;IACxF,SAAS,CAAC,KAAK,CAAC,CAAA;IAChB,OAAO,KAAK,CAAA;AACd,CAAC"}

package/esm/utils/inspect.spec.js

@@ -1,3 +1,4 @@
+/* eslint-disable no-console */
 import { jest } from '@jest/globals';
 import { inspect } from './index.js';
 describe(`${inspect.name}()`, () => {
@@ -11,5 +12,13 @@ describe(`${inspect.name}()`, () => {
         inspect(value, spy);
         expect(spy).toBeCalledWith(value);
     });
+    it('defaults to console.dir', () => {
+        const value = { a: 1, b: 2 };
+        const dir = console.dir;
+        console.dir = jest.fn();
+        inspect(value);
+        expect(console.dir).toBeCalledWith(value);
+        console.dir = dir;
+    });
 });
 //# sourceMappingURL=inspect.spec.js.map

package/esm/utils/inspect.spec.js.map

@@ -1 +1 @@
-{"version":3,"file":"inspect.spec.js","sourceRoot":"","sources":["../../ts/utils/inspect.spec.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,eAAe,CAAA;AACpC,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAA;AAEpC,QAAQ,CAAC,GAAG,OAAO,CAAC,IAAI,IAAI,EAAE,GAAG,EAAE;IACjC,EAAE,CAAC,8BAA8B,EAAE,GAAG,EAAE;QACtC,MAAM,KAAK,GAAG,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAA;QAC5B,MAAM,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;IAC/C,CAAC,CAAC,CAAA;IACF,EAAE,CAAC,2BAA2B,EAAE,GAAG,EAAE;QACnC,MAAM,KAAK,GAAG,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAA;QAC5B,MAAM,GAAG,GAAG,IAAI,CAAC,EAAE,EAAE,CAAA;QACrB,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAA;QACnB,MAAM,CAAC,GAAG,CAAC,CAAC,cAAc,CAAC,KAAK,CAAC,CAAA;IACnC,CAAC,CAAC,CAAA;AACJ,CAAC,CAAC,CAAA"}
+{"version":3,"file":"inspect.spec.js","sourceRoot":"","sources":["../../ts/utils/inspect.spec.ts"],"names":[],"mappings":"AAAA,+BAA+B;AAC/B,OAAO,EAAE,IAAI,EAAE,MAAM,eAAe,CAAA;AACpC,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAA;AAEpC,QAAQ,CAAC,GAAG,OAAO,CAAC,IAAI,IAAI,EAAE,GAAG,EAAE;IACjC,EAAE,CAAC,8BAA8B,EAAE,GAAG,EAAE;QACtC,MAAM,KAAK,GAAG,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAA;QAC5B,MAAM,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;IAC/C,CAAC,CAAC,CAAA;IACF,EAAE,CAAC,2BAA2B,EAAE,GAAG,EAAE;QACnC,MAAM,KAAK,GAAG,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAA;QAC5B,MAAM,GAAG,GAAG,IAAI,CAAC,EAAE,EAAE,CAAA;QACrB,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAA;QACnB,MAAM,CAAC,GAAG,CAAC,CAAC,cAAc,CAAC,KAAK,CAAC,CAAA;IACnC,CAAC,CAAC,CAAA;IACF,EAAE,CAAC,yBAAyB,EAAE,GAAG,EAAE;QACjC,MAAM,KAAK,GAAG,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAA;QAC5B,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,CAAA;QACvB,OAAO,CAAC,GAAG,GAAG,IAAI,CAAC,EAAE,EAAE,CAAA;QACvB,OAAO,CAAC,KAAK,CAAC,CAAA;QACd,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,cAAc,CAAC,KAAK,CAAC,CAAA;QACzC,OAAO,CAAC,GAAG,GAAG,GAAG,CAAA;IACnB,CAAC,CAAC,CAAA;AACJ,CAAC,CAAC,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "type-plus",
-  "version": "5.5.1",
+  "version": "5.5.2",
   "description": "Provides additional types for TypeScript.",
   "homepage": "https://github.com/unional/type-plus",
   "bugs": {
@@ -69,7 +69,7 @@
     "typedoc-plugin-extras": "^2.2.3",
     "typescript": "^4.9.4"
   },
-  "packageManager": "pnpm@7.25.0",
+  "packageManager": "pnpm@7.25.1",
   "size-limit": [
     {
       "path": "./cjs/index.js",

package/ts/utils/inspect.ts

@@ -1,7 +1,9 @@
+/* eslint-disable no-console */
+
 /**
  * Inspects the value and returns it.
  */
-export function inspect<T>(value: T, inspector: (value: Readonly<T>) => void): T {
+export function inspect<T>(value: T, inspector: (value: Readonly<T>) => void = console.dir): T {
   inspector(value)
   return value
 }