Security News
The Push to Ban Ransom Payments Is Gaining Momentum
Ransomware costs victims an estimated $30 billion per year and has gotten so out of control that global support for banning payments is gaining momentum.
@base2/pretty-print-object
Advanced tools
Readme
Convert an object or array into a formatted string
This is a re-write of stringify-object in Typescript, modified to inline the dependencies and make it compatible with ES5 out of the box.
Useful for when you want to get the string representation of an object in a formatted way.
It also handles circular references and lets you specify quote type.
$ npm install @base2/pretty-print-object
import { prettyPrint } from '@base2/pretty-print-object';
const obj = {
foo: 'bar',
'arr': [1, 2, 3],
nested: {
hello: "world"
}
};
const pretty = prettyPrint(obj, {
indent: ' ',
singleQuotes: false
});
console.log(pretty);
/*
{
foo: "bar",
arr: [
1,
2,
3
],
nested: {
hello: "world"
}
}
*/
Circular references will be replaced with "[Circular]"
.
Object keys are only quoted when necessary, for example, {'foo-bar': true}
.
Type: Object
Array
Type: Object
Type: string
Default: \t
Preferred indentation.
Type: boolean
Default: true
Set to false to get double-quoted strings.
Type: Function
Expected to return a boolean
of whether to include the property prop
of the object obj
in the output.
Type: Function
Default: undefined
Expected to return a string
that transforms the string that resulted from stringifying obj[prop]
. This can be used to detect special types of objects that need to be stringified in a particular way. The transform
function might return an alternate string in this case, otherwise returning the originalResult
.
Here's an example that uses the transform
option to mask fields named "password":
import { prettyPrint } from '@base2/pretty-print-object';
const obj = {
user: 'becky',
password: 'secret'
};
const pretty = prettyPrint(obj, {
transform: (obj, prop, originalResult) => {
if (prop === 'password') {
return originalResult.replace(/\w/g, '*');
}
return originalResult;
}
});
console.log(pretty);
/*
{
user: 'becky',
password: '******'
}
*/
Type: number
When set, will inline values up to inlineCharacterLimit
length for the sake of more terse output.
For example, given the example at the top of the README:
import { prettyPrint } from '@base2/pretty-print-object';
const obj = {
foo: 'bar',
'arr': [1, 2, 3],
nested: {
hello: "world"
}
};
const pretty = prettyPrint(obj, {
indent: ' ',
singleQuotes: false,
inlineCharacterLimit: 12
});
console.log(pretty);
/*
{
foo: "bar",
arr: [1, 2, 3],
nested: {
hello: "world"
}
}
*/
As you can see, arr
was printed as a one-liner because its string was shorter than 12 characters.
FAQs
Convert an object or array into a formatted string
We found that @base2/pretty-print-object demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Ransomware costs victims an estimated $30 billion per year and has gotten so out of control that global support for banning payments is gaining momentum.
Application Security
New SEC disclosure rules aim to enforce timely cyber incident reporting, but fear of job loss and inadequate resources lead to significant underreporting.
Security News
The Python Software Foundation has secured a 5-year sponsorship from Fastly that supports PSF's activities and events, most notably the security and reliability of the Python Package Index (PyPI).