aboutsummaryrefslogtreecommitdiff
path: root/node_modules/strip-json-comments/index.d.ts
diff options
context:
space:
mode:
Diffstat (limited to 'node_modules/strip-json-comments/index.d.ts')
-rw-r--r--node_modules/strip-json-comments/index.d.ts36
1 files changed, 36 insertions, 0 deletions
diff --git a/node_modules/strip-json-comments/index.d.ts b/node_modules/strip-json-comments/index.d.ts
new file mode 100644
index 0000000..28ba3c8
--- /dev/null
+++ b/node_modules/strip-json-comments/index.d.ts
@@ -0,0 +1,36 @@
+declare namespace stripJsonComments {
+ interface Options {
+ /**
+ Replace comments 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
+```
+const json = `{
+ // Rainbows
+ "unicorn": "cake"
+}`;
+
+JSON.parse(stripJsonComments(json));
+//=> {unicorn: 'cake'}
+```
+*/
+declare function stripJsonComments(
+ jsonString: string,
+ options?: stripJsonComments.Options
+): string;
+
+export = stripJsonComments;