@naturalcycles/nodejs-lib/dist/string/inspectAny.d.ts

Standard library for Node.js

/// <reference types="node" />
import { InspectOptions } from 'util';
import { StringifyAnyOptions, JsonStringifyFunction } from '@naturalcycles/js-lib';
export interface InspectAnyOptions extends StringifyAnyOptions, InspectOptions {
}
/**
 * Just a convenience export of a const that fulfills the JsonStringifyFunction interface.
 */
export declare const inspectAnyStringifyFn: JsonStringifyFunction;
/**
 * Transforms ANY to human-readable string (via util.inspect mainly).
 * Safe (no error throwing).
 *
 * Correclty prints Errors, AppErrors, ErrorObjects: error.message + \n + inspect(error.data)
 *
 * Enforces max length (default to 10_000, pass 0 to skip it).
 *
 * Logs numbers as-is, e.g: `6`.
 * Logs strings as-is (without single quotes around, unlike default util.inspect behavior).
 * Otherwise - just uses util.inspect() with reasonable defaults.
 *
 * Returns 'empty_string' if empty string is passed.
 * Returns 'undefined' if undefined is passed (default util.inspect behavior).
 *
 * Based on `_stringifyAny` from `js-lib`, just replaced `JSON.stringify` with `util.inspect`.
 */
export declare function inspectAny(obj: any, opt?: InspectAnyOptions): string;