stringify-object-extract-functions

stringify-object

Stringify an object/array like JSON.stringify just without all the double-quotes.

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.

Install

$ npm install --save stringify-object

Usage

var obj = {
    foo: 'bar',
    'arr': [1, 2, 3],
    nested: { hello: "world" }
};
 
var pretty = stringifyObject(obj, {
    indent: '  ',
    singleQuotes: false
});
 
console.log(pretty);
/*
{
    foo: "bar",
    arr: [
        1,
        2,
        3
    ],
    nested: {
        hello: "world"
    }
}
*/

API

stringifyObject(input, [options])

Circular references will be replaced with "[Circular]".

input

Required
Type: object, array

options

indent

Type: string
Default: '\t'

Choose the indentation you prefer.

singleQuotes

Type: boolean
Default: true

Set to false to get double-quoted strings.

filter(obj, prop)

Type: function

Expected to return a boolean of whether to keep the object.

inlineCharacterLimit

Type: number Default: undefined

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:

var obj = {
    foo: 'bar',
    'arr': [1, 2, 3],
    nested: { hello: "world" }
};
 
var pretty = stringifyObject(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.

extractFunctions

Type: boolean
Default: false

Stringifies inner code of functions.

var obj = {
    assets: function() { [foo, bar] }
}
 
var pretty = stringifyObject(obj, {
    extractFunctions: true
}
console.log(pretty);
/*
{
    assets: [foo, bar]
}
*/

License

BSD license © Vladimir Kalmykov, Yeoman Team