@npm2cjs/strip-json-comments
TypeScript icon, indicating that this package has built-in type declarations

5.0.0 • Public • Published

@npm2cjs/strip-json-comments


🌈 🌛
🌞 ❄️

该npm包由 npm2cjs 转译工具生成.

原npm包: strip-json-comments

下面为原npm包的README内容

strip-json-comments

Strip comments from JSON. Lets you use comments in your JSON files!

This is now possible:

{
	// Rainbows
	"unicorn": /* ❤ */ "cake"
}

It will replace single-line comments // and multi-line comments /**/ with whitespace. This allows JSON error positions to remain as close as possible to the original source.

Also available as a Gulp/Grunt/Broccoli plugin.

Install

npm install strip-json-comments

Usage

import stripJsonComments from 'strip-json-comments';

const json = `{
	// Rainbows
	"unicorn": /* ❤ */ "cake"
}`;

JSON.parse(stripJsonComments(json));
//=> {unicorn: 'cake'}

API

stripJsonComments(jsonString, options?)

jsonString

Type: string

Accepts a string with JSON and returns a string without comments.

options

Type: object

trailingCommas

Type: boolean
Default: false

Strip trailing commas in addition to comments.

whitespace

Type: boolean
Default: true

Replace comments and trailing commas with whitespace instead of stripping them entirely.

Benchmark

npm run bench

Related


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.

Package Sidebar

Install

npm i @npm2cjs/strip-json-comments

Weekly Downloads

0

Version

5.0.0

License

MIT

Unpacked Size

7.79 kB

Total Files

4

Last publish

Collaborators

  • juln