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
:electron: Build cross-platform desktop apps with JavaScript, HTML, and CSS -
cheerio
The fast, flexible, and elegant library for parsing and manipulating HTML and XML. -
jsdom
A JavaScript implementation of various web standards, for use with Node.js -
v86
x86 virtualization in your browser, recompiling x86 to wasm on the fly -
dotenv
Loads environment variables from .env for nodejs projects. -
patch-package
Fix broken node modules instantly ๐๐ฝโโ๏ธ๐จ -
ssh2
SSH2 client and server modules written in pure JavaScript for node.js -
hypernova
A service for server-side rendering your JavaScript views -
simplecrawler
Flexible event driven crawler for node. -
file-type
Detect the file type of a Buffer/Uint8Array/ArrayBuffer -
webworker-threads
Lightweight Web Worker API implementation with native threads -
node-pre-gyp
Node.js tool for easy binary deployment of C++ addons -
banshee
Real-time anomalies detection for periodic time series. -
Bottleneck
Job scheduler and rate limiter, supports Clustering -
mem
Memoize functions - an optimization technique used to speed up consecutive function calls by caching the result of calls with identical input -
hasha
Hashing made simple. Get the hash of a buffer/string/stream/file. -
dot-prop
Get, set, or delete a property from a nested object using a dot path -
node-bell
Real-time anomalies detection for periodic time series. -
basic-ftp
FTP client for Node.js, supports FTPS over TLS, passive mode over IPv6, async/await, and Typescript. -
schemapack
Create a schema object to encode/decode your JSON in to a compact byte buffer with no overhead. -
nar
node.js application archive - create self-contained binary like executable applications that are ready to ship and run -
stringify-object
Stringify an object/array like JSON.stringify just without all the double-quotes -
common-errors
Common error classes and utility functions -
cashify
๐ธ Lightweight currency conversion library, successor of money.js -
node-video-lib
Node.js Video Library / MP4 & FLV parser / MP4 builder / HLS muxer -
require-uncached
Import a module while bypassing the cache -
resolve-from
Resolve the path of a module like require.resolve() but from a given path
Appwrite - The Open Source Firebase alternative introduces iOS support
* Code Quality Rankings and insights are calculated and provided by Lumnify.
They vary from L1 to L5 with "L5" being the highest.
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