2.3.4 • Published 8 years ago

stringify-object-with-oneline v2.3.4

Weekly downloads
3
License
BSD-2-Clause
Repository
github
Last release
8 years ago

stringify-object Build Status

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-with-oneline

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.

oneline

Type: boolean
Default: false

Set to generate object in one line.

filter(obj, prop)

Type: function

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

License

BSD license and copyright Google