{"_id":"nicely-format","_rev":"120448","name":"nicely-format","description":"Copy of avajs/pretty-format","dist-tags":{"latest":"1.1.0"},"maintainers":[{"name":"dylang","email":""}],"time":{"modified":"2021-06-03T10:56:11.000Z","created":"2017-02-21T17:00:08.716Z","1.1.0":"2017-02-21T17:00:08.716Z"},"users":{},"author":{"name":"James Kyle","email":"me@thejameskyle.com"},"repository":{"type":"git","url":"git+https://github.com/avajs/pretty-format.git"},"versions":{"1.1.0":{"name":"nicely-format","version":"1.1.0","description":"Copy of avajs/pretty-format","license":"MIT","repository":{"type":"git","url":"git+https://github.com/avajs/pretty-format.git"},"author":{"name":"James Kyle","email":"me@thejameskyle.com"},"scripts":{"test":"jest","perf":"node perf/test.js"},"dependencies":{"ansi-styles":"^2.2.1","esutils":"^2.0.2"},"devDependencies":{"chalk":"^1.1.3","jest":"^15.1.1","left-pad":"^1.1.1","react":"15.3.0"},"jest":{"testEnvironment":"node","verbose":true},"gitHead":"2ffd9cdcef03cf63d42ab80bd3c899e875718048","bugs":{"url":"https://github.com/avajs/pretty-format/issues"},"homepage":"https://github.com/avajs/pretty-format#readme","_id":"nicely-format@1.1.0","_shasum":"6c3513d1f38077d65ed9721e716a8e1917ba27b6","_from":".","_npmVersion":"3.10.8","_nodeVersion":"6.9.1","_npmUser":{"name":"dylang","email":"dylang@gmail.com"},"dist":{"shasum":"6c3513d1f38077d65ed9721e716a8e1917ba27b6","size":49462,"noattachment":false,"key":"/nicely-format/-/nicely-format-1.1.0.tgz","tarball":"http://registry.cnpm.dingdandao.com/nicely-format/download/nicely-format-1.1.0.tgz"},"maintainers":[{"name":"dylang","email":""}],"_npmOperationalInternal":{"host":"packages-12-west.internal.npmjs.com","tmp":"tmp/nicely-format-1.1.0.tgz_1487696408492_0.46986614959314466"},"directories":{},"publish_time":1487696408716,"_cnpm_publish_time":1487696408716,"_hasShrinkwrap":false}},"readme":"# @ava/pretty-format [![Travis build status](http://img.shields.io/travis/avajs/pretty-format.svg?style=flat)](https://travis-ci.org/avajs/pretty-format)\n\n> Stringify any JavaScript value.\n\n- Supports [all built-in JavaScript types](#type-support)\n- [Blazingly fast](https://gist.github.com/thejameskyle/2b04ffe4941aafa8f970de077843a8fd) (similar performance to v8's `JSON.stringify` and significantly faster than Node's `util.format`)\n- Plugin system for extending with custom types (i.e. [`ReactTestComponent`](#reacttestcomponent-plugin))\n\n\n## Installation\n\n```sh\n$ npm install @ava/pretty-format\n```\n\n## Usage\n\n```js\nvar prettyFormat = require('pretty-format');\n\nvar obj = { property: {} };\nobj.circularReference = obj;\nobj[Symbol('foo')] = 'foo';\nobj.map = new Map();\nobj.map.set('prop', 'value');\nobj.array = [1, NaN, Infinity];\n\nconsole.log(prettyFormat(obj));\n```\n\n**Result:**\n\n```js\nObject {\n \"property\": Object {},\n \"circularReference\": [Circular],\n \"map\": Map {\n \"prop\" => \"value\"\n },\n \"array\": Array [\n 1,\n NaN,\n Infinity\n ],\n Symbol(foo): \"foo\"\n}\n```\n\n#### Type Support\n\n`Object`, `Array`, `ArrayBuffer`, `DataView`, `Float32Array`, `Float64Array`, `Int8Array`, `Int16Array`, `Int32Array`, `Uint8Array`, `Uint8ClampedArray`, `Uint16Array`, `Uint32Array`, `arguments`, `Boolean`, `Date`, `Error`, `Function`, `Infinity`, `Map`, `NaN`, `null`, `Number`, `RegExp`, `Set`, `String`, `Symbol`, `undefined`, `WeakMap`, `WeakSet`\n\n### API\n\n```js\nconsole.log(prettyFormat(object));\nconsole.log(prettyFormat(object, options));\n```\n\nOptions:\n\n* **`callToJSON`**
\n Type: `boolean`, default: `true`
\n Call `toJSON()` on passed object.\n* **`indent`**
\n Type: `number`, default: `2`
\n Number of spaces for indentation.\n* **`maxDepth`**
\n Type: `number`, default: `Infinity`
\n Print only this number of levels.\n* **`min`**
\n Type: `boolean`, default: `false`
\n Print without whitespace.\n* **`plugins`**
\n Type: `array`, default: `[]`
\n Plugins (see the next section).\n* **`printFunctionName`**
\n Type: `boolean`, default: `true`
\n Print function names or just `[Function]`.\n* **`escapeRegex`**
\n Type: `boolean`, default: `false`
\n Escape special characters in regular expressions.\n* **`highlight`**
\n Type: `boolean`, default: `false`
\n Highlight syntax for terminal (works only with `ReactTestComponent` and `ReactElement` plugins.\n* **`theme`**
\n Type: `object`, default: `{tag: 'cyan', content: 'reset'...}`
\n Syntax highlight theme.
\n Uses [ansi-styles colors](https://github.com/chalk/ansi-styles#colors) + `reset` for no color.
\n Available types: `tag`, `content`, `prop` and `value`.\n\n### Plugins\n\nPretty format also supports adding plugins:\n\n```js\nvar fooPlugin = {\n test: function(val) {\n return val && val.hasOwnProperty('foo');\n },\n print: function(val, print, indent) {\n return 'Foo: ' + print(val.foo);\n }\n};\n\nvar obj = { foo: { bar: {} } };\n\nprettyFormat(obj, {\n plugins: [fooPlugin]\n});\n// Foo: Object {\n// \"bar\": Object {}\n// }\n```\n\n#### `ReactTestComponent` and `ReactElement` plugins\n\n```js\nvar prettyFormat = require('pretty-format');\nvar reactTestPlugin = require('pretty-format/plugins/ReactTestComponent');\nvar reactElementPlugin = require('pretty-format/plugins/ReactElement');\n\nvar React = require('react');\nvar renderer = require('react-test-renderer');\n\nvar jsx = React.createElement('h1', null, 'Hello World');\n\nprettyFormat(renderer.create(jsx).toJSON(), {\n plugins: [reactTestPlugin, reactElementPlugin]\n});\n//

\n// Hello World\n//

\n```\n","_attachments":{},"homepage":"https://github.com/avajs/pretty-format#readme","bugs":{"url":"https://github.com/avajs/pretty-format/issues"},"license":"MIT"}