Description
Function to prettyprint an object with an ability to annotate every value.
Prettyprint Object alternatives and similar modules
Based on the "Miscellaneous" category.
Alternatively, view Prettyprint Object alternatives based on common mentions on social networks and blogs.
-
Electron
Build cross platform desktop apps with web technologies. (You might like awesome-electron) -
cheerio
Fast, flexible, and lean implementation of core jQuery designed specifically for the server. -
v86
x86 virtualization in JavaScript, running in your browser and NodeJS -
hypernova
A service for server-side rendering your JavaScript views. -
opencv
Bindings for OpenCV. The defacto computer vision library. -
patch-package
Make and preserve fixes to npm dependencies. -
nan
A header file filled with macro and utility goodness for making add-on development for across Node.js versions easier. -
webworker-threads
Lightweight Web Worker API implementation with native threads. -
banshee
Real-time anomalies detection for periodic time series. -
node-pre-gyp
Makes it easy to publish and install Node.js C++ addons from binaries. -
Bottleneck
A powerful rate limiter that makes throttling easy. -
hasha
Hashing made simple. Get the hash of a buffer/string/stream/file. -
node-bell
Real-time anomalies detection for periodic time series. -
dot-prop
Get a property from a nested object using a dot path. -
schemapack
Create a schema object to encode/decode your JSON in to a compact byte buffer with no overhead. -
common-errors
Common error classes and utility functions. -
stringify-object
Stringify an object/array like JSON.stringify just without all the double-quotes. -
node-video-lib
Pure JavaScript library for working with MP4 and FLV video files and creating MPEG-TS chunks for HLS streaming. -
require-uncached
Require a module bypassing the cache. -
resolve-from
Resolve the path of a module like require.resolve() but from a given path. -
strip-bom
Strip UTF-8 byte order mark (BOM) from a string/buffer/stream.
Scout APM - Leading-edge performance monitoring starting at $39/month
* Code Quality Rankings and insights are calculated and provided by Lumnify.
They vary from L1 to L5 with "L5" being the highest. Visit our partner's website for more details.
Do you think we are missing an alternative of Prettyprint Object or a related project?
README
Prettyprint Object
Function to prettyprint an object with an ability to annotate every value.
API
/**
* @typedef {Object} optionsType
* @property {string} indentTemplate String used to indent one level of code (default: ' ').
* @property {valueIndex|null} valueIndex A function used to index values in the object, the line of declaration in the output and the internal type of the value.
*/
/**
* @param {Object} subject
* @param {optionsType} options
* @returns {string}
*/
prettyprint;
Use
import prettyprint from 'prettyprint';
Format Object for console.log
console.log(prettyprint({
foo: 'FOO',
bar: 'BAR',
emptyArray: [],
emptyObject: {},
arrayWithLiteralValues: [
1,
2,
3
],
objectWithLiteralValues: {
1: 'foo',
2: 'bar',
3: 'baz',
},
types: [
undefined,
null,
function (a, b) {},
(a, b) => {},
NaN,
Infinity,
10.2,
true
]
}));
{
foo: "FOO",
bar: "BAR",
emptyArray: [],
emptyObject: {},
arrayWithLiteralValues: [
1,
2,
3
],
objectWithLiteralValues: {
1: "foo",
2: "bar",
3: "baz"
},
types: [
undefined,
null,
function (a, b) { ... },
(a, b) => { ... },
NaN,
Infinity,
10.2,
true
]
}
Annotate Value Types
This library provides a method createValueIndex
.
import {
createValueIndex
} from 'prettyprint';
createValueIndex
is a factory function that will produce an instance of valueIndex
. valueIndex
object implements methods add
and increment
. These methods are used internally to keep track of where and what values are added to the formatted object string.
getValueIndexData
method returns an object describing the collected data, e.g.
{
1: {
path: [
'foo'
]
value: 'foo',
type: 'string'
}
}
For this example, we are going to build a helper function formatAnnotatedObject
that formats object output, indexes object values and annotates the formatted output with value types.
import _ from 'lodash';
import prettyprint, {
createValueIndex
} from 'prettyprint';
let formatAnnotatedObject;
formatAnnotatedObject = (subject) => {
let formattedValue,
valueIndex,
valueIndexData;
valueIndex = createValueIndex();
formattedValue = prettyprint(subject, {
valueIndex: valueIndex
});
valueIndexData = valueIndex.getValueIndexData();
return formattedValue = _.map(formattedValue.split('\n'), (line, linuNumber) => {
if (_.has(valueIndexData, linuNumber)) {
line += ' : ' + valueIndexData[linuNumber].type;
}
return line;
}).join('\n');
};
We are going to annotate data from the previous example:
console.log(formatAnnotatedObject({
foo: 'FOO',
bar: 'BAR',
emptyArray: [],
emptyObject: {},
arrayWithLiteralValues: [
1,
2,
3
],
objectWithLiteralValues: {
1: 'foo',
2: 'bar',
3: 'baz',
},
types: [
undefined,
null,
function (a, b) {},
(a, b) => {},
NaN,
Infinity,
10.2,
true
]
}));
{
foo: "FOO", : string
bar: "BAR", : string
emptyArray: [], : array
emptyObject: {}, : object
arrayWithLiteralValues: [
1, : number
2, : number
3 : number
], : array
objectWithLiteralValues: {
1: "foo", : string
2: "bar", : string
3: "baz" : string
}, : object
types: [
undefined, : undefined
null, : null
function (a, b) { ... }, : function
(a, b) => { ... }, : function
NaN, : nan
Infinity, : number
10.2, : number
true : boolean
] : array
} : object
Install
npm install prettyprint