Sha256: 0d6c88d4e5a9944b29ba56c7d563c4a7ef5cee816d3269e50aab627afbc98568
Contents?: true
Size: 910 Bytes
Versions: 15
Compression:
Stored size: 910 Bytes
Contents
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;
Version data entries
15 entries across 15 versions & 1 rubygems