Palak Handa / startUpJalsa-Backend

Blame view

node_modules/strip-json-comments/readme.md 1.46 KB
edit raw normal view history
f7563de62   Palak Handa   first commit 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
 
  # 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 comments from JSON. Lets you use comments in your JSON files!
  
  This is now possible:
  
  ```js
  {
  	// 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.
  
  
  ## Install
  
  ```
  $ npm install --save strip-json-comments
  ```
  
  
  ## Usage
  
  ```js
  const json = '{/*rainbows*/"unicorn":"cake"}';
  
  JSON.parse(stripJsonComments(json));
  //=> {unicorn: 'cake'}
  ```
  
  
  ## API
  
  ### stripJsonComments(input, [options])
  
  #### input
  
  Type: `string`
  
  Accepts a string with JSON and returns a string without comments.
  
  #### options
  
  ##### whitespace
  
  Type: `boolean`  
  Default: `true`
  
  Replace comments with whitespace instead of stripping them entirely.
  
  
  ## 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)