# print > Generate a human-readable representation of a value. Latest version **1.2.0** (published 2020-05-10) · ISC license · 0 weekly downloads ## Install ```sh npm install print pnpm add print yarn add print bun add print ``` ## Health **Score 15/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 1.2.0 | | Published | 2020-05-10 | | First published | 2012-07-09 | | Weekly downloads | 0 | | License | ISC | | TypeScript types | none | | Module format | CommonJS | | Node | >=6.0.0 | | Dependencies | 0 | | Unpacked size | 19.2 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 8 | | Author | John Gardner | | Maintainers | alhadis | | Keywords | stringify, trace, debug, outline, format, string | ## Links - npm: https://www.npmjs.com/package/print - Repository: https://github.com/Alhadis/Print - Homepage: https://github.com/Alhadis/Print#readme - Issues: https://github.com/Alhadis/Print/issues - npm.io page: https://npm.io/package/print ## Alternatives - [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads - [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads - [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads - [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads - [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads ## Recent versions - 1.2.0 (latest) — 2020-05-10 - 1.1.0 — 2018-03-21 - 1.0.2 — 2016-12-22 - 1.0.1 — 2016-10-01 - 1.0.0 — 2016-08-25 - 0.0.0 — 2012-07-09 ## README Print ===== [![Build status: TravisCI][TravisCI-badge]][TravisCI-link] [![Build status: AppVeyor][AppVeyor-badge]][AppVeyor-link] [![Coverage status][Coverage-badge]][Coverage-link] [![Latest release][NPM-badge]][NPM-link] Generate a human-readable representation of a value. Focussed on producing clean and *accurate* depictions of data. Suitable for debugging and generating diffs. Usage ----- ```js const print = require("print"); let output = print({ foo: "bar", baz: "quux", list: [1, 2, 3, 4, "five"] }); console.log(output); print.out(obj); // Shortcut for console.log(print(obj)); ``` ### Comparison with built-in functions ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ print JSON.stringify util.inspect { { { foo: 'bar', baz: "quux" "foo": "bar", baz: 'quux', foo: "bar" "baz": "quux", list: list: [ "list": [ [ 1, 1 1, 2, 2 2, 3, 3 3, 4, 4 4, 'five' ] } "five" "five" ] ] } } ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ `print` also handles circular references by showing a `->` pointing to where the object was first mentioned. For example, the following code: ```js const A = {}; const B = {foo: A}; print({A, B}); ``` Will produce: ~~~ { A: {} B: { foo: -> A } } ~~~ Options ------- An optional second parameter can be passed to refine `print`'s output. Available options and their default values are listed below: ```js print(input, { ampedSymbols: true, escapeChars: /(?!\x20)\s|\\/g, invokeGetters: false, maxArrayLength: 100, showAll: false, showArrayIndices: false, showArrayLength: false, sortProps: true }); ``` ### ampedSymbols [Boolean] Prefix [Symbol]-keyed properties with `@@`. Disable to show `Symbol(…)` instead. ### escapeChars [RegExp] | [Function] What characters, if any, are escaped in string values. By default, anything that alters the output's meaning or layout is escaped: \f \n \r \t \v \\ This can be overridden with a custom expression or callback, the latter of which receives the entire string as an argument. Passing falsey values to `escapeChars` disables escaping altogether, which isn't recommended if your input contains line-breaks or tabulation. ### invokeGetters [Boolean] Permit `print` to call a property getter to display its computed value. Invoking a getter can have unwanted side-effects, so this option is disabled by default. ### maxArrayLength [Number] Maximum number of array values to show before truncating them: ~~~ [ 1 2 3 … 7 more values not shown ] ~~~ Note this excludes any named properties stored on the Array object: ```js const input = [1, 2, 3, 4, 5, 6, 7, 8, 9, 10]; input.foo = "bar"; print(input, { maxArrayLength: 3 }) ``` ~~~ [ 1 2 3 … 7 more values not shown foo: "bar" ] ~~~ ### showAll [Boolean] Include non-enumerable properties when printing an object. Note that inherited properties are *always* hidden. ### showArrayIndices [Boolean] Show the index of each element in an array. ~~~ [ [ "A" 0: "A" "B" -> 1: "B" "C" 2: "C" ] ] ~~~ ### showArrayLength [Boolean] Display an array's `length` property after its values: ~~~ [ "A" "B" "C" length: 3 ] ~~~ ### sortProps [Boolean] Alphabetise the properties of printed objects. To display properties in the order they were assigned, set this to `false`. Note that alphabetisation is case-insensitive. [AppVeyor-badge]: https://img.shields.io/appveyor/build/Alhadis/Print [AppVeyor-link]: https://ci.appveyor.com/project/Alhadis/Print [TravisCI-badge]: https://img.shields.io/travis/build/Alhadis/Print [TravisCI-link]: https://travis-ci.org/Alhadis/Print [Coverage-badge]: https://coveralls.io/repos/github/Alhadis/Print/badge.svg [Coverage-link]: https://coveralls.io/github/Alhadis/Print [NPM-badge]: https://img.shields.io/npm/v/print.svg?colorB=brightgreen [NPM-link]: https://github.com/Alhadis/Print/releases/latest [Boolean]: http://mdn.io/JavaScript/Reference/Global_Objects/Boolean [Function]: http://mdn.io/JavaScript/Reference/Global_Objects/Function [Number]: http://mdn.io/JavaScript/Reference/Global_Objects/Number [RegExp]: http://mdn.io/JavaScript/Reference/Global_Objects/RegExp [Symbol]: http://mdn.io/JavaScript/Reference/Global_Objects/Symbol --- _Source: https://npm.io/package/print · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._