Better inspect formatting, using prettier for arrays, objects and functions, and util.inspect for everything else.
npm install prettier-inspect> Better inspect formatting, using prettier for arrays, objects and functions, and util.inspect for everything else.
Please consider following this project's author, Jon Schlinkert, and consider starring the project to show your :heart: and support.
Details
- Install
- Usage
- Examples
* Arrays
* Buffers
* Dates
* Errors
* Functions
* Numbers
* Objects
* Regular expressions
* Strings
* RegExp.exec and String.match arguments
- Release history
- About
Install with npm:
``sh`
$ npm install --save prettier-inspect
`js`
var inspect = require('prettier-inspect');
console.log(inspect(value[, options]));
Params
* value - any javascript valueoptions
* - options to pass to prettier
The following examples are based on the default options.
`js`
function fn( a, b ){return a + b}
console.log(inspect([{a: 'b', c: 'd', e: 'f', fn: fn}]));
Prints:
`js`
[
{
a: 'b',
c: 'd',
e: 'f',
fn: function fn(a, b) {
return a + b;
}
}
];
`js`
console.log(inspect(new Buffer('foo')));
//=>
`js`
console.log(inspect(new Date()));
//=> 2017-12-01T21:33:21.938Z
`js`
console.log(inspect(new Error('this is an error!')));
Prints:
``
Error: this is an error!
at Object.
at Module._compile (module.js:641:30)
at Object.Module._extensions..js (module.js:652:10)
at Module.load (module.js:560:32)
at tryModuleLoad (module.js:503:12)
at Function.Module._load (module.js:495:3)
at Function.Module.runMain (module.js:682:10)
at startup (bootstrap_node.js:191:16)
at bootstrap_node.js:613:3
`js`
function fn( a, b ){return a + b}
console.log(inspect(fn));
Prints:
`js`
function fn(a, b) {
return a + b;
}
`js`
console.log(inspect(9));
//=> 9
`js`
console.log(inspect({
obj: {
a: [ { foo: 'bar', baz: { qux: 'fez'} }],
c: 'd', e: 'f',
g: function (one, two){return one + two},
h: {a: 'b', c: 'd'},
regex: /^foo(?=bar)/g }
}));
Prints:
`js`
{
obj: {
a: [
{
foo: 'bar',
baz: { qux: 'fez' }
}
],
c: 'd',
e: 'f',
g: function(one, two) {
return one + two;
},
h: {
a: 'b',
c: 'd'
},
regex: /^foo(?=bar)/g
}
};
`js`
console.log(inspect(/^foo$/));
//=> /^foo$/
`js`
console.log(inspect('foo\nbar'));
//=> 'foo\nbar'
`js`
console.log(inspect(/foo/.exec('foo')));
//=> [ 'foo', index: 0, input: 'foo' ]
See the changelog for updates.
Contributing
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
Please read the contributing guide for advice on opening issues, pull requests, and coding standards.
Running Tests
Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:
`sh`
$ npm install && npm test
Building docs
_(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)_
To generate the readme, run the following command:
`sh`
$ npm install -g verbose/verb#dev verb-generate-readme && verb
You might also be interested in these projects:
* is-plain-object: Returns true if an object was created by the Object constructor. | Object` constructor."" class="text-primary hover:underline" target="_blank" rel="noopener noreferrer">homepage
* kind-of: Get the native type of a value. | homepage
Jon Schlinkert
* linkedin/in/jonschlinkert
* github/jonschlinkert
* twitter/jonschlinkert
Copyright © 2017, Jon Schlinkert.
Released under the MIT License.
*
_This file was generated by verb-generate-readme, v0.6.0, on December 01, 2017._