![\"downloads\"](\"https://img.shields.io/npm/dm/showify.svg\")
\n \n \n ![\"npm](\"https://img.shields.io/npm/v/showify.svg\")
\n \n \n ![\"minzipped](\"https://img.shields.io/bundlephobia/minzip/showify.svg\")
\n \n \n ![\"coverage](\"https://coveralls.io/repos/github/Snowflyt/showify/badge.svg?branch=main\"){kind=icon}
\n \n \n ![\"MPL](\"https://img.shields.io/npm/l/showify.svg\")
\n \n\n Arguably the most comprehensive cross-platform library for stringifying any JavaScript value into a human-readable format, handling nearly every scenario you might encounter.\n
\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
| β | ![\"minzipped](\"https://img.shields.io/bundlephobia/minzip/pretty-format.svg\")
| ![\"minzipped](\"https://img.shields.io/bundlephobia/minzip/object-inspect.svg\")
| ![\"minzipped](\"https://img.shields.io/bundlephobia/minzip/stringify-object.svg\")
|\n| Indentation | β
| π‘ uncustomizable | β
| β
| β
|\n| Auto line breaking | β
| β
| β | β | β |\n| Array elements grouping [1] | β
| β
| β | β | β |\n| Circular references | β
| β
| β
| β
| β
|\n| Circular reference pointers | β
| β
| β | β | β |\n| Maximum recursion depth | β
| β
| β
| β
| β |\n| ANSI colors | β
| β
| πΆ | β | β |\n| Sorted keys | β
| β
| β
| β | β |\n| Auto select proper quote style for strings | β
| β
| β | β | β |\n| Custom quote style | β
| β | β | π‘ [2] | π‘ [2] |\n| Auto line break for long multiline strings | β
| β
| β | β | β |\n| Trailing comma | β
| β | π‘ forced | β | β |\n| Hidden (non-enumerable) properties | β
[3] | β
| β | β | β |\n| Proper getters/setters inspection [3] | β
| β
| β | β | β |\n| `Symbol.toStringTag` support | β
| β
| β | π‘ | β |\n| Custom serializers | β
| β
| β
| β
| β
|\n| Promise inspection | π‘ [4] | β
| β | β | β |\n| WeakMap/WeakSet inspection | π‘ [5] | β
| β | β | β |\n| Proxy inspection | β | β
| β | β | β |\n\n\n
[1, 2, 3, 4, 5, 6, 7, 8, 9, 10], which can be displayed as [\\n 1, 2, 3, 4,\\n 5, 6, 7, 8,\\n 9, 10\\n] instead of placing each element on a separate line.showHidden: boolean from Node.js, showify also provides an \"exclude-meta\" option, which behaves like true but removes common meta properties like the length property of arrays from the output.Promise objects are displayed as Promise { <state unknown> }, since itβs impossible to determine the state of a Promise without awaiting it.WeakMap and WeakSet objects are displayed as ${className} { <items unknown> } even when showHidden is \"always\", since itβs impossible to retrieve the values of a WeakMap or WeakSet without knowing the keys.\"none\" | \"always\" | \"exclude-meta\" | boolean | `\"none\"` | Whether to show hidden (non-enumerable) properties, should be `\"none\"`, `\"always\"`, or `\"exclude-meta\"`. If set to `\"exclude-meta\"`, it behaves like `\"always\"` but removes common meta properties like the `length` property of arrays. For compatibility with Node.jsβs `util.inspect`, `true` is also accepted as `\"always\"`, and `false` is also accepted as `\"none\"`, but it is recommended to use the string values for clarity. |\n| `getters` | \"none\" | \"get\" | \"set\" | \"all\" | boolean | `\"none\"` | Whether to inspect getters. If set to `\"get\"`, only getters without a corresponding setter are inspected. If set to `\"set\"`, only getters with a corresponding setter are inspected. If set to `\"all\"`, all getters are inspected. For compatibility with Node.jsβs `util.inspect`, `true` is also accepted as `\"all\"`, and `false` is also accepted as `\"none\"`, but it is recommended to use the string values for clarity. |\n| `sorted` | `boolean` | `false` | Whether to sort the keys of objects (including `Map`s and `Set`s) in the resulting string. |\n| `omittedKeys` | Set<string | symbol> | `new Set()` | A set of keys to omit from the output. Note that this option is _not recursive_ and only omits the top-level keys. |\n| `quoteStyle` | \"single\" | \"double\" | \"backtick\" | `[\"double\", \"single\", \"backtick\"]` | Preferred quote style for strings. If an array is provided, **showify** tries each quote style in order. |\n| `quoteKeys` | \"auto\" | \"always\" | `\"auto\"` | Whether to quote object keys. If set to `\"auto\"`, object keys are quoted only when necessary. |\n| `numericSeparator` | \"none\" | string | boolean | `\"none\"` | The thousands separator for numbers (including BigInts), e.g., `\",\"` or `\"_\"`. If set to `\"none\"`, no separator is used. For compatibility with Node.jsβs `util.inspect`, `true` is also accepted as `\"_\"`, and `false` is also accepted as `\"none\"`, but it is recommended to use the string values for clarity. |\n| `trailingComma` | \"none\" | \"always\" | \"auto\" | `\"none\"` | Whether to add a trailing comma to the last element of an array or object. If set to `\"auto\"`, a trailing comma is added only when the last item is on a separate line. |\n| `arrayBracketSpacing` | `boolean` | `false` | Whether to add spaces inside the brackets of arrays. |\n| `objectCurlySpacing` | `boolean` | `true` | Whether to add spaces inside the curly braces of objects. |\n| `referencePointer` | `boolean` | `true` | Whether to display circular references with a reference pointer. If set to `false`, circular references are displayed as `[Circular]`. |\n| `maxArrayLength` | `number` | `Infinity` | Maximum number of elements to display for arrays, `Map`s, and `Set`s. If one of these collections has more elements than `maxArrayLength`, the output is truncated and includes the omitted count. |\n| `maxStringLength` | `number` | `Infinity` | Maximum length of a string to display. If a string is longer than `maxStringLength`, it is displayed as `\"${s}\"... ${n} more character${n === 1 ? \"\" : \"s}\"`. |\n| `colors` | `boolean` | `false` | Whether to enable ANSI colors. |\n| `styles` | `Object` | `{}` | Custom styles for different types of values. Valid keys are `string`, `symbol`, `number`, `bigint`, `boolean`, `null`, `undefined`, `date`, `regexp`, and `special`. Valid colors are `bold`, `dim`, `reset`, `black`, `blue`, `cyan`, `gray`, `green`, `magenta`, `red`, `white`, `yellow`, and functions that take a string and return a string (for advanced styling). |\n| `serializers` | `Serializer[]` | `[]` | Custom serializers for your own types. See the [custom serializers section](#custom-serializers) for more details. |\n\n### Custom Serializers\n\n**showify** supports three ways to customize the serialization of objects:\n\n- Using the special `Symbol(nodejs.util.inspect.custom)` property on objects (compatible with Node.js).\n- Using the `serializers` option in the `show()` function.\n- Using the **showify**βs own `Symbol(showify.inspect.custom)` property on objects (not compatible with Node.js).\n\n**showify** aims to be fully compatible with Node.jsβs `Symbol(nodejs.util.inspect.custom)` property, so examples from the [Node.js documentation](https://nodejs.org/api/util.html#custom-inspection-functions-on-objects) should work with **showify** as well. Hereβs an example adapted from the Node.js documentation that works seamlessly with **showify**:\n\n```typescript\nimport { type InspectOptions, type InspectOptionsStylized, show } from \"showify\";\n\nclass Box {\n constructor(value) {\n this.value = value;\n }\n\n [Symbol.for(\"nodejs.util.inspect.custom\")](\n depth: number,\n options: InspectOptionsStylized,\n inspect: (value: unknown, options?: InspectOptions) => any,\n ) {\n if (depth < 0) {\n return options.stylize(\"[Box]\", \"special\");\n }\n\n const newOptions = Object.assign({}, options, {\n depth: options.depth === null ? null : options.depth - 1,\n });\n\n // Five space padding because thatβs the size of \"Box< \".\n const padding = \" \".repeat(5);\n const inner = inspect(this.value, newOptions).replace(/\\n/g, `\\n${padding}`);\n return `${options.stylize(\"Box\", \"special\")}< ${inner} >`;\n }\n}\n\nconst box = new Box(true);\n\nconsole.log(show(box, { colors: true, indent: 2, depth: 2 }));\n// \"Box< true >\"\n```\n\nWhile this approach works, we generally recommend using custom serializers through the `serializers` option in the `show()` function, as it is more flexible and allows for better control over the serialization process. In **showify**, a serializer must implement the following interface:\n\n```typescript\ninterface Serializer {\n if: (value: object, options: SerializerOptions) => boolean;\n then: (\n value: object,\n options: SerializerOptions,\n expand: (value: unknown, options?: Partial