Marc Mintel
5397309103
Some checks failed
Build & Deploy / 🔍 Prepare (push) Successful in 20s
Build & Deploy / 🧪 QA (push) Failing after 34s
Build & Deploy / 🏗️ Build (push) Has started running
Build & Deploy / 🚀 Deploy (push) Has been cancelled
Build & Deploy / 🧪 Smoke Test (push) Has been cancelled
Build & Deploy / ⚡ Lighthouse (push) Has been cancelled
Build & Deploy / 🔔 Notify (push) Has been cancelled
42 lines
910 B
Plaintext
42 lines
910 B
Plaintext
export type Options = {
|
|
/**
|
|
Strip trailing commas in addition to comments.
|
|
|
|
@default false
|
|
*/
|
|
readonly trailingCommas?: boolean;
|
|
|
|
/**
|
|
Replace comments and trailing commas with whitespace instead of stripping them entirely.
|
|
|
|
@default true
|
|
*/
|
|
readonly whitespace?: boolean;
|
|
};
|
|
|
|
/**
|
|
Strip comments from JSON. Lets you use comments in your JSON files!
|
|
|
|
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.
|
|
|
|
@param jsonString - Accepts a string with JSON.
|
|
@returns A JSON string without comments.
|
|
|
|
@example
|
|
```
|
|
import stripJsonComments from 'strip-json-comments';
|
|
|
|
const json = `{
|
|
// Rainbows
|
|
"unicorn": "cake"
|
|
}`;
|
|
|
|
JSON.parse(stripJsonComments(json));
|
|
//=> {unicorn: 'cake'}
|
|
```
|
|
*/
|
|
export default function stripJsonComments(
|
|
jsonString: string,
|
|
options?: Options
|
|
): string;
|