stringify-json-object

Stringify and format a JSON object.

If I should maintain this repo, please ⭐️

DM me on Twitter if you have questions or suggestions.

Installation

yarn add stringify-json-object

npm install stringify-json-object

pnpm add stringify-json-object

Usage

The stringify function works like JSON.stringify:

import stringify from "stringify-json-object";

stringify(true); // 'true'
stringify(1); // '1'
stringify("foo"); // '"foo"'
stringify({ foo: "bar" }); // '{"foo":"bar"}'
stringify({ foo: "bar", missing: undefined }); // '{"foo":"bar"}'

The stringify function also accepts an options argument, to easily format the output:

import stringify from "stringify-json-object";

stringify({ foo: "bar" }, { pretty: true }); // '{\n  "foo": "bar"\n}"

Additionally, primitives resolve to typed string literals:

import stringify from "stringify-json-object";

stringify(true); // "true"
stringify(1); // "1"
stringify("foo"); // "\"foo\""
stringify({ foo: "bar" }); // string

Dependencies

types-json: Type checking for JSON values

Dev Dependencies

autorepo: Autorepo abstracts away your dev dependencies, providing a single command to run all of your scripts.

License

MIT

Related Packages

parse-json-object: Parse a typed JSON object

Current Tags

3.0.0 ... latest (2 years ago)