@naturalcycles/js-lib 14.127.0 → 14.128.0

package/dist/string/stringifyAny.d.ts

@@ -1,4 +1,18 @@
 import type { Reviver } from '../types';
+/**
+ * Allows to set Global "stringifyFunction" that will be used to "pretty-print" objects
+ * in various cases.
+ *
+ * Used, for example, by _stringifyAny() to pretty-print objects/arrays.
+ *
+ * Defaults to _safeJsonStringify.
+ *
+ * Node.js project can set it to _inspectAny, which allows to use `util.inspect`
+ * as pretty-printing function.
+ *
+ * It's recommended that this function is circular-reference-safe.
+ */
+export declare function setGlobalStringifyFunction(fn: JsonStringifyFunction): void;
 export type JsonStringifyFunction = (obj: any, reviver?: Reviver, space?: number) => string;
 export interface StringifyAnyOptions {
     /**
@@ -22,7 +36,7 @@ export interface StringifyAnyOptions {
      * Allows to pass custom "stringify function".
      * E.g in Node.js you can pass `util.inspect` instead.
      *
-     * @default JSON.stringify
+     * Defaults to `globalStringifyFunction`, which defaults to `_safeJsonStringify`
      */
     stringifyFn?: JsonStringifyFunction;
 }

package/dist/string/stringifyAny.js

@@ -1,9 +1,27 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports._stringifyAny = void 0;
+exports._stringifyAny = exports.setGlobalStringifyFunction = void 0;
 const error_util_1 = require("../error/error.util");
 const json_util_1 = require("./json.util");
 const safeJsonStringify_1 = require("./safeJsonStringify");
+let globalStringifyFunction = safeJsonStringify_1._safeJsonStringify;
+/**
+ * Allows to set Global "stringifyFunction" that will be used to "pretty-print" objects
+ * in various cases.
+ *
+ * Used, for example, by _stringifyAny() to pretty-print objects/arrays.
+ *
+ * Defaults to _safeJsonStringify.
+ *
+ * Node.js project can set it to _inspectAny, which allows to use `util.inspect`
+ * as pretty-printing function.
+ *
+ * It's recommended that this function is circular-reference-safe.
+ */
+function setGlobalStringifyFunction(fn) {
+    globalStringifyFunction = fn;
+}
+exports.setGlobalStringifyFunction = setGlobalStringifyFunction;
 /**
  * Inspired by inspectAny from nodejs-lib, which is based on util.inpect that is not available in the Browser.
  * Potentially can do this (with extra 2Kb gz size): https://github.com/deecewan/browser-util-inspect
@@ -86,7 +104,7 @@ function _stringifyAny(obj, opt = {}) {
         // Other
         //
         try {
-            const { stringifyFn = safeJsonStringify_1._safeJsonStringify } = opt;
+            const { stringifyFn = globalStringifyFunction } = opt;
             s = stringifyFn(obj, undefined, 2);
         }
         catch {

package/dist-esm/string/stringifyAny.js

@@ -1,6 +1,23 @@
 import { _isErrorObject, _isHttpErrorObject, _isHttpErrorResponse } from '../error/error.util';
 import { _jsonParseIfPossible } from './json.util';
 import { _safeJsonStringify } from './safeJsonStringify';
+let globalStringifyFunction = _safeJsonStringify;
+/**
+ * Allows to set Global "stringifyFunction" that will be used to "pretty-print" objects
+ * in various cases.
+ *
+ * Used, for example, by _stringifyAny() to pretty-print objects/arrays.
+ *
+ * Defaults to _safeJsonStringify.
+ *
+ * Node.js project can set it to _inspectAny, which allows to use `util.inspect`
+ * as pretty-printing function.
+ *
+ * It's recommended that this function is circular-reference-safe.
+ */
+export function setGlobalStringifyFunction(fn) {
+    globalStringifyFunction = fn;
+}
 /**
  * Inspired by inspectAny from nodejs-lib, which is based on util.inpect that is not available in the Browser.
  * Potentially can do this (with extra 2Kb gz size): https://github.com/deecewan/browser-util-inspect
@@ -83,7 +100,7 @@ export function _stringifyAny(obj, opt = {}) {
         // Other
         //
         try {
-            const { stringifyFn = _safeJsonStringify } = opt;
+            const { stringifyFn = globalStringifyFunction } = opt;
             s = stringifyFn(obj, undefined, 2);
         }
         catch (_a) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@naturalcycles/js-lib",
-  "version": "14.127.0",
+  "version": "14.128.0",
   "scripts": {
     "prepare": "husky install",
     "build-prod": "build-prod-esm-cjs",

package/src/string/stringifyAny.ts

@@ -3,6 +3,25 @@ import type { Reviver } from '../types'
 import { _jsonParseIfPossible } from './json.util'
 import { _safeJsonStringify } from './safeJsonStringify'
 
+let globalStringifyFunction: JsonStringifyFunction = _safeJsonStringify
+
+/**
+ * Allows to set Global "stringifyFunction" that will be used to "pretty-print" objects
+ * in various cases.
+ *
+ * Used, for example, by _stringifyAny() to pretty-print objects/arrays.
+ *
+ * Defaults to _safeJsonStringify.
+ *
+ * Node.js project can set it to _inspectAny, which allows to use `util.inspect`
+ * as pretty-printing function.
+ *
+ * It's recommended that this function is circular-reference-safe.
+ */
+export function setGlobalStringifyFunction(fn: JsonStringifyFunction): void {
+  globalStringifyFunction = fn
+}
+
 export type JsonStringifyFunction = (obj: any, reviver?: Reviver, space?: number) => string
 
 export interface StringifyAnyOptions {
@@ -30,7 +49,7 @@ export interface StringifyAnyOptions {
    * Allows to pass custom "stringify function".
    * E.g in Node.js you can pass `util.inspect` instead.
    *
-   * @default JSON.stringify
+   * Defaults to `globalStringifyFunction`, which defaults to `_safeJsonStringify`
    */
   stringifyFn?: JsonStringifyFunction
 }
@@ -120,7 +139,7 @@ export function _stringifyAny(obj: any, opt: StringifyAnyOptions = {}): string {
     // Other
     //
     try {
-      const { stringifyFn = _safeJsonStringify } = opt
+      const { stringifyFn = globalStringifyFunction } = opt
 
       s = stringifyFn(obj, undefined, 2)
     } catch {