npmpackage.info

javascript-stringify

Stringify is to `eval` as `JSON.stringify` is to `JSON.parse`

2.1.0

140

MIT

TypeScript

400,043,117 4.1

Installations

npm install javascript-stringify

Pull Requests

Open

0

Total

25

Closed

4

Merged

21

Issues

Open

8

Total

18

Closed

10

Releases

Use `Buffer.from`

v2.1.0

Published on 14 Apr 2021

Custom Function Properties

v2.0.1

Published on 05 Nov 2019

ESNext Function Syntaxes + TypeScript

v2.0.0

Published on 06 Mar 2019

Handle `Error`, `Map` and `Set`

v1.6.0

Published on 23 Feb 2017

Skip Undefined Properties

v1.5.0

Published on 02 Nov 2016

Max Values

v1.4.0

Published on 19 Aug 2016

View all 13 releases

Developer

blakeembrey

Developer Guide

BETA

Module System

CommonJS

Min. Node Version

Typescript Support

Yes

Node Version

15.14.0

NPM Version

7.9.0 Statistics

140 Stars

81 Commits

16 Forks

5 Watching

1 Branches

8 Contributors

Updated on 29 Sept 2024

Languages

TypeScript (100%)

Total Downloads

Cumulative downloads

Total Downloads

400,043,117

Last day

-4.1%

403,676

Compared to previous day

Last week

2.7%

2,294,433

Compared to previous week

Last month

12.4%

9,416,664

Compared to previous month

Last year

3.5%

97,061,238

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dev Dependencies

@borderless/ts-scripts @types/jest @types/node @types/semver fast-check semver typescript

Versions

JavaScript Stringify

Stringify is to eval as JSON.stringify is to JSON.parse.

Installation

npm install javascript-stringify --save

Usage

1import { stringify } from "javascript-stringify";

The API is similar JSON.stringify:

value The value to convert to a string
replacer A function that alters the behavior of the stringification process
space A string or number that's used to insert white space into the output for readability purposes
options
- maxDepth (number, default: 100) The maximum depth of values to stringify
- maxValues (number, default: 100000) The maximum number of values to stringify
- references (boolean, default: false) Restore circular/repeated references in the object (uses IIFE)
- skipUndefinedProperties (boolean, default: false) Omits undefined properties instead of restoring as undefined

Examples

1stringify({}); // "{}"
2stringify(true); // "true"
3stringify("foo"); // "'foo'"
4
5stringify({ x: 5, y: 6 }); // "{x:5,y:6}"
6stringify([1, 2, 3, "string"]); // "[1,2,3,'string']"
7
8stringify({ a: { b: { c: 1 } } }, null, null, { maxDepth: 2 }); // "{a:{b:{}}}"
9
10/**
11 * Invalid key names are automatically stringified.
12 */
13stringify({ "some-key": 10 }); // "{'some-key':10}"
14
15/**
16 * Some object types and values can remain identical.
17 */
18stringify([/.+/gi, new Number(10), new Date()]); // "[/.+/gi,new Number(10),new Date(1406623295732)]"
19
20/**
21 * Unknown or circular references are removed.
22 */
23var obj = { x: 10 };
24obj.circular = obj;
25
26stringify(obj); // "{x:10}"
27stringify(obj, null, null, { references: true }); // "(function(){var x={x:10};x.circular=x;return x;}())"
28
29/**
30 * Specify indentation - just like `JSON.stringify`.
31 */
32stringify({ a: 2 }, null, " "); // "{\n a: 2\n}"
33stringify({ uno: 1, dos: 2 }, null, "\t"); // "{\n\tuno: 1,\n\tdos: 2\n}"
34
35/**
36 * Add custom replacer behaviour - like double quoted strings.
37 */
38stringify(["test", "string"], function (value, indent, stringify) {
39  if (typeof value === "string") {
40    return '"' + value.replace(/"/g, '\\"') + '"';
41  }
42
43  return stringify(value);
44});
45//=> '["test","string"]'

Formatting

You can use your own code formatter on the result of javascript-stringify. Here is an example using eslint:

1const { CLIEngine } = require("eslint");
2const { stringify } = require("javascript-stringify");
3
4const { APP_ROOT_PATH, ESLINTRC_FILE_PATH } = require("./constants");
5
6const ESLINT_CLI = new CLIEngine({
7  fix: true,
8  cwd: APP_ROOT_PATH,
9  configFile: ESLINTRC_FILE_PATH,
10});
11
12module.exports = (objectToStringify) => {
13  return ESLINT_CLI.executeOnText(stringify(objectToStringify)).results[0]
14    .output;
15};

License

MIT

No vulnerabilities found.

10

Security-Policy

Determines if the project has published a security policy.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

10

Fuzzing

Determines if the project uses fuzzing.

2

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

2

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

Maintained

Determines if the project is "actively maintained".

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

4.1

/10

Last Scanned on 2024-11-25

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More