1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
|
# stringify-object [](http://travis-ci.org/yeoman/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
```js
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:
```js
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.
## License
[BSD license](http://opensource.org/licenses/bsd-license.php) © Yeoman Team
|
