Big update!Introducing GitHub Bot Commands. Learn more
Socket
Log inBook a demo

stringify-object

Package Overview
Dependencies
3
Maintainers
10
Versions
27
Issues
File Explorer

Advanced tools

stringify-object

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

    4.0.1latest

Version published
Maintainers
10
Weekly downloads
6,934,038
decreased by-9.16%

Weekly downloads

Changelog

Source

  • Fix improper string escaping (#72) 699cef7

https://github.com/yeoman/stringify-object/compare/v4.0.0...v4.0.1

Readme

Source

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 stringify-object

Usage

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

Object keys are only quoted when necessary, for example, {'foo-bar': true}.

input

Type: object | Array

options

Type: object

indent

Type: string
Default: \t

Preferred indentation.

singleQuotes

Type: boolean
Default: true

Set to false to get double-quoted strings.

filter(object, property)

Type: Function

Expected to return a boolean of whether to include the property property of the object object in the output.

transform(object, property, originalResult)

Type: Function
Default: undefined

Expected to return a string that transforms the string that resulted from stringifying object[property]. 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 stringifyObject from 'stringify-object'; const object = { user: 'becky', password: 'secret' }; const pretty = stringifyObject(object, { transform: (object, property, originalResult) => { if (property === 'password') { return originalResult.replace(/\w/g, '*'); } return originalResult; } }); console.log(pretty); /* { user: 'becky', password: '******' } */
inlineCharacterLimit

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


Get professional support for this package with a Tidelift subscription
Tidelift helps make open source sustainable for maintainers while giving companies
assurances about security, maintenance, and licensing for their dependencies.

Keywords

FAQs

What is stringify-object?

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

Is stringify-object popular?

The npm package stringify-object receives a total of 6,544,146 weekly downloads. As such, stringify-object popularity was classified as popular.

Is stringify-object well maintained?

We found that stringify-object demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago.It has 10 open source maintainers collaborating on the project.

Last updated on 15 Feb 2022

Did you know?

Socket installs a Github app to automatically flag issues on every pull request and report the health of your dependencies. Find out what is inside your node modules and prevent malicious activity before you update the dependencies.

Install Socket
Socket

Product

Subscribe to our newsletter

Get open source security insights delivered straight into your inbox. Be the first to learn about new features and product updates.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc