strip-json-comments

Functions

• stripJsonComments()

Type Aliases

• Options

function stripJsonComments

stripJsonComments: (jsonString: string, options?: Options) => string;

• 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.

  Parameter jsonString

  Accepts a string with JSON.

  Returns

  A JSON string without comments.

  Example 1

  import stripJsonComments from 'strip-json-comments';
  
  const json = `{
  	// Rainbows
  	"unicorn": "cake"
  }`;
  
  JSON.parse(stripJsonComments(json));
  //=> {unicorn: 'cake'}

type Options

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;
};