保誠-保戶業務員媒合平台
HelenHuang
2022-06-09 9bdb95c9e34cef640534e5e5a1e2225a80442000
PAMapp/node_modules/strip-json-comments/readme.md
@@ -1,4 +1,4 @@
# strip-json-comments [![Build Status](https://travis-ci.org/sindresorhus/strip-json-comments.svg?branch=master)](https://travis-ci.org/sindresorhus/strip-json-comments)
# strip-json-comments [![Build Status](https://travis-ci.com/sindresorhus/strip-json-comments.svg?branch=master)](https://travis-ci.com/github/sindresorhus/strip-json-comments)
> Strip comments from JSON. Lets you use comments in your JSON files!
@@ -6,38 +6,38 @@
```js
{
   // rainbows
   // 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](https://github.com/sindresorhus/gulp-strip-json-comments)/[grunt](https://github.com/sindresorhus/grunt-strip-json-comments)/[broccoli](https://github.com/sindresorhus/broccoli-strip-json-comments) plugin.
Also available as a [Gulp](https://github.com/sindresorhus/gulp-strip-json-comments)/[Grunt](https://github.com/sindresorhus/grunt-strip-json-comments)/[Broccoli](https://github.com/sindresorhus/broccoli-strip-json-comments) plugin.
## Install
```
$ npm install --save strip-json-comments
$ npm install strip-json-comments
```
## Usage
```js
const json = '{/*rainbows*/"unicorn":"cake"}';
const json = `{
   // Rainbows
   "unicorn": /* ❤ */ "cake"
}`;
JSON.parse(stripJsonComments(json));
//=> {unicorn: 'cake'}
```
## API
### stripJsonComments(input, [options])
### stripJsonComments(jsonString, options?)
#### input
#### jsonString
Type: `string`
@@ -45,20 +45,34 @@
#### options
Type: `object`
##### whitespace
Type: `boolean`
Type: `boolean`\
Default: `true`
Replace comments with whitespace instead of stripping them entirely.
## Benchmark
```
$ npm run bench
```
## Related
- [strip-json-comments-cli](https://github.com/sindresorhus/strip-json-comments-cli) - CLI for this module
- [strip-css-comments](https://github.com/sindresorhus/strip-css-comments) - Strip comments from CSS
---
## License
MIT © [Sindre Sorhus](http://sindresorhus.com)
<div align="center">
   <b>
      <a href="https://tidelift.com/subscription/pkg/npm-strip-json-comments?utm_source=npm-strip-json-comments&utm_medium=referral&utm_campaign=readme">Get professional support for this package with a Tidelift subscription</a>
   </b>
   <br>
   <sub>
      Tidelift helps make open source sustainable for maintainers while giving companies<br>assurances about security, maintenance, and licensing for their dependencies.
   </sub>
</div>