aboutsummaryrefslogtreecommitdiff
path: root/node_modules/json5/lib/stringify.d.ts
diff options
context:
space:
mode:
authorJoel Kronqvist <joel.h.kronqvist@gmail.com>2022-03-05 19:02:27 +0200
committerJoel Kronqvist <joel.h.kronqvist@gmail.com>2022-03-05 19:02:27 +0200
commit5d309ff52cd399a6b71968a6b9a70c8ac0b98981 (patch)
tree360f7eb50f956e2367ef38fa1fc6ac7ac5258042 /node_modules/json5/lib/stringify.d.ts
parentb500a50f1b97d93c98b36ed9a980f8188d648147 (diff)
downloadLYLLRuoka-5d309ff52cd399a6b71968a6b9a70c8ac0b98981.tar.gz
LYLLRuoka-5d309ff52cd399a6b71968a6b9a70c8ac0b98981.zip
Added node_modules for the updating to work properly.
Diffstat (limited to 'node_modules/json5/lib/stringify.d.ts')
-rw-r--r--node_modules/json5/lib/stringify.d.ts89
1 files changed, 89 insertions, 0 deletions
diff --git a/node_modules/json5/lib/stringify.d.ts b/node_modules/json5/lib/stringify.d.ts
new file mode 100644
index 0000000..3c34838
--- /dev/null
+++ b/node_modules/json5/lib/stringify.d.ts
@@ -0,0 +1,89 @@
+declare type StringifyOptions = {
+ /**
+ * A function that alters the behavior of the stringification process, or an
+ * array of String and Number objects that serve as a allowlist for
+ * selecting/filtering the properties of the value object to be included in
+ * the JSON5 string. If this value is null or not provided, all properties
+ * of the object are included in the resulting JSON5 string.
+ */
+ replacer?:
+ | ((this: any, key: string, value: any) => any)
+ | (string | number)[]
+ | null
+
+ /**
+ * A String or Number object that's used to insert white space into the
+ * output JSON5 string for readability purposes. If this is a Number, it
+ * indicates the number of space characters to use as white space; this
+ * number is capped at 10 (if it is greater, the value is just 10). Values
+ * less than 1 indicate that no space should be used. If this is a String,
+ * the string (or the first 10 characters of the string, if it's longer than
+ * that) is used as white space. If this parameter is not provided (or is
+ * null), no white space is used. If white space is used, trailing commas
+ * will be used in objects and arrays.
+ */
+ space?: string | number | null
+
+ /**
+ * A String representing the quote character to use when serializing
+ * strings.
+ */
+ quote?: string | null
+}
+
+/**
+ * Converts a JavaScript value to a JSON5 string.
+ * @param value The value to convert to a JSON5 string.
+ * @param replacer A function that alters the behavior of the stringification
+ * process. If this value is null or not provided, all properties of the object
+ * are included in the resulting JSON5 string.
+ * @param space A String or Number object that's used to insert white space into
+ * the output JSON5 string for readability purposes. If this is a Number, it
+ * indicates the number of space characters to use as white space; this number
+ * is capped at 10 (if it is greater, the value is just 10). Values less than 1
+ * indicate that no space should be used. If this is a String, the string (or
+ * the first 10 characters of the string, if it's longer than that) is used as
+ * white space. If this parameter is not provided (or is null), no white space
+ * is used. If white space is used, trailing commas will be used in objects and
+ * arrays.
+ * @returns The JSON5 string converted from the JavaScript value.
+ */
+declare function stringify(
+ value: any,
+ replacer?: ((this: any, key: string, value: any) => any) | null,
+ space?: string | number | null,
+): string
+
+/**
+ * Converts a JavaScript value to a JSON5 string.
+ * @param value The value to convert to a JSON5 string.
+ * @param replacer An array of String and Number objects that serve as a
+ * allowlist for selecting/filtering the properties of the value object to be
+ * included in the JSON5 string. If this value is null or not provided, all
+ * properties of the object are included in the resulting JSON5 string.
+ * @param space A String or Number object that's used to insert white space into
+ * the output JSON5 string for readability purposes. If this is a Number, it
+ * indicates the number of space characters to use as white space; this number
+ * is capped at 10 (if it is greater, the value is just 10). Values less than 1
+ * indicate that no space should be used. If this is a String, the string (or
+ * the first 10 characters of the string, if it's longer than that) is used as
+ * white space. If this parameter is not provided (or is null), no white space
+ * is used. If white space is used, trailing commas will be used in objects and
+ * arrays.
+ * @returns The JSON5 string converted from the JavaScript value.
+ */
+declare function stringify(
+ value: any,
+ replacer: (string | number)[],
+ space?: string | number | null,
+): string
+
+/**
+ * Converts a JavaScript value to a JSON5 string.
+ * @param value The value to convert to a JSON5 string.
+ * @param options An object specifying options.
+ * @returns The JSON5 string converted from the JavaScript value.
+ */
+declare function stringify(value: any, options: StringifyOptions): string
+
+export = stringify