From aa2d7762589dd4ace5df684f5a33165e047a492e Mon Sep 17 00:00:00 2001 From: George Pickering <29524044+geopic@users.noreply.github.com> Date: Wed, 12 Aug 2020 21:49:29 +0100 Subject: [PATCH 1/3] Add types declaration file with entry in package.json --- lib/types.d.ts | 39 +++++++++++++++++++++++++++++++++++++++ package.json | 1 + 2 files changed, 40 insertions(+) create mode 100644 lib/types.d.ts diff --git a/lib/types.d.ts b/lib/types.d.ts new file mode 100644 index 00000000..38d6240d --- /dev/null +++ b/lib/types.d.ts @@ -0,0 +1,39 @@ +declare module 'json5' { + /** + * Parses a JSON5 string, constructing the JavaScript value or object described + * by the string. An optional reviver function can be provided to perform a + * transformation on the resulting object before it is returned. + * @param text The string to parse as JSON5. + * @param reviver If a function, this prescribes how the value originally produced by parsing is transformed, before being returned. + */ + export function parse(text: string, reviver?: (this: any, key: string, value: any) => any): any; + + /** + * Converts a JavaScript value to a JSON5 string, optionally replacing values if a + * replacer function is specified, or optionally including only the specified + * properties if a replacer array is specified. + * @param value The value to convert to a JSON5 string. + * @param replacer A function that alters the behavior of the stringification process, or an array of String and Number objects that serve as a whitelist 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. + */ + export function stringify(value: any, replacer?: (this: any, key: string, value: any) => any, space?: string | number): string; + + /** + * Converts a JavaScript value to a JSON5 string, optionally replacing values if a + * replacer function is specified, or optionally including only the specified + * properties if a replacer array is specified. + * @param value The value to convert to a JSON5 string. + * @param options An object with the following properties: + * + * `replacer`: Same as the `replacer` parameter. + * + * `space`: Same as the `space` parameter. + * + * `quote`: A String representing the quote character to use when serializing strings. + */ + export function stringify(value: any, options?: Partial<{ + replacer: (this: any, key: string, value: any) => any; + space: string | number; + quote: string; + }>): string; +} diff --git a/package.json b/package.json index 9c5b82ea..3c07170d 100644 --- a/package.json +++ b/package.json @@ -6,6 +6,7 @@ "module": "dist/index.mjs", "bin": "lib/cli.js", "browser": "dist/index.js", + "types": "lib/types.d.ts", "files": [ "lib/", "dist/" From 78030b3c96cb0fec1428698b1735f6c0304dacac Mon Sep 17 00:00:00 2001 From: George Pickering <29524044+geopic@users.noreply.github.com> Date: Thu, 13 Aug 2020 19:13:40 +0100 Subject: [PATCH 2/3] Amend types declaration file (add StringifyOptions type) --- lib/types.d.ts | 23 ++++++++++++++++++----- 1 file changed, 18 insertions(+), 5 deletions(-) diff --git a/lib/types.d.ts b/lib/types.d.ts index 38d6240d..65612024 100644 --- a/lib/types.d.ts +++ b/lib/types.d.ts @@ -1,4 +1,21 @@ declare module 'json5' { + type StringifyOptions = Partial<{ + /** + * A function that alters the behavior of the stringification process, or an array of String and Number objects that serve as a whitelist 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; + + /** + * 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; + + /** + * A String representing the quote character to use when serializing strings. + */ + quote: string; + }> + /** * Parses a JSON5 string, constructing the JavaScript value or object described * by the string. An optional reviver function can be provided to perform a @@ -31,9 +48,5 @@ declare module 'json5' { * * `quote`: A String representing the quote character to use when serializing strings. */ - export function stringify(value: any, options?: Partial<{ - replacer: (this: any, key: string, value: any) => any; - space: string | number; - quote: string; - }>): string; + export function stringify(value: any, options?: StringifyOptions): string; } From b7b8feae1e6aff940e2e1e61d48ccffbb4a61f56 Mon Sep 17 00:00:00 2001 From: George Pickering <29524044+geopic@users.noreply.github.com> Date: Wed, 27 Jan 2021 13:15:22 +0000 Subject: [PATCH 3/3] Amend types declaration file (cleanup, fix issues) --- lib/index.d.ts | 76 ++++++++++++++++++++++++++++++++++++++++++++++++++ lib/types.d.ts | 52 ---------------------------------- package.json | 2 +- 3 files changed, 77 insertions(+), 53 deletions(-) create mode 100644 lib/index.d.ts delete mode 100644 lib/types.d.ts diff --git a/lib/index.d.ts b/lib/index.d.ts new file mode 100644 index 00000000..c2b002af --- /dev/null +++ b/lib/index.d.ts @@ -0,0 +1,76 @@ +declare type StringifyOptions = Partial<{ + /** + * A function that alters the behavior of the stringification process, or an + * array of String and Number objects that serve as a whitelist 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)[]; + + /** + * 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; + + /** + * A String representing the quote character to use when serializing strings. + */ + quote: string; +}> + +/** + * Parses a JSON5 string, constructing the JavaScript value or object described + * by the string. An optional reviver function can be provided to perform a + * transformation on the resulting object before it is returned. + * @param text The string to parse as JSON5. + * @param reviver If a function, this prescribes how the value originally + * produced by parsing is transformed, before being returned. + */ +export function parse(text: string, reviver?: (this: any, key: string, value: any) => any): any; + +/** + * Converts a JavaScript value to a JSON5 string, optionally replacing values + * if a replacer function is specified, or optionally including only the + * specified properties if a replacer array is specified. + * @param value The value to convert to a JSON5 string. + * @param replacer A function that alters the behavior of the stringification + * process, or an array of String and Number objects that serve as a whitelist + * 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. + */ +export function stringify(value: any, replacer?: ((this: any, key: string, value: any) => any) | (string | number)[], space?: string | number): string; + +/** + * Converts a JavaScript value to a JSON5 string, optionally replacing values + * if a replacer function is specified, or optionally including only the + * specified properties if a replacer array is specified. + * @param value The value to convert to a JSON5 string. + * @param options An object with the following properties: + * + * `replacer`: Same as the `replacer` parameter. + * + * `space`: Same as the `space` parameter. + * + * `quote`: A String representing the quote character to use when serializing + * strings. + */ +export function stringify(value: any, options?: StringifyOptions): string; diff --git a/lib/types.d.ts b/lib/types.d.ts deleted file mode 100644 index 65612024..00000000 --- a/lib/types.d.ts +++ /dev/null @@ -1,52 +0,0 @@ -declare module 'json5' { - type StringifyOptions = Partial<{ - /** - * A function that alters the behavior of the stringification process, or an array of String and Number objects that serve as a whitelist 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; - - /** - * 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; - - /** - * A String representing the quote character to use when serializing strings. - */ - quote: string; - }> - - /** - * Parses a JSON5 string, constructing the JavaScript value or object described - * by the string. An optional reviver function can be provided to perform a - * transformation on the resulting object before it is returned. - * @param text The string to parse as JSON5. - * @param reviver If a function, this prescribes how the value originally produced by parsing is transformed, before being returned. - */ - export function parse(text: string, reviver?: (this: any, key: string, value: any) => any): any; - - /** - * Converts a JavaScript value to a JSON5 string, optionally replacing values if a - * replacer function is specified, or optionally including only the specified - * properties if a replacer array is specified. - * @param value The value to convert to a JSON5 string. - * @param replacer A function that alters the behavior of the stringification process, or an array of String and Number objects that serve as a whitelist 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. - */ - export function stringify(value: any, replacer?: (this: any, key: string, value: any) => any, space?: string | number): string; - - /** - * Converts a JavaScript value to a JSON5 string, optionally replacing values if a - * replacer function is specified, or optionally including only the specified - * properties if a replacer array is specified. - * @param value The value to convert to a JSON5 string. - * @param options An object with the following properties: - * - * `replacer`: Same as the `replacer` parameter. - * - * `space`: Same as the `space` parameter. - * - * `quote`: A String representing the quote character to use when serializing strings. - */ - export function stringify(value: any, options?: StringifyOptions): string; -} diff --git a/package.json b/package.json index 3c07170d..3b3b79a5 100644 --- a/package.json +++ b/package.json @@ -6,7 +6,7 @@ "module": "dist/index.mjs", "bin": "lib/cli.js", "browser": "dist/index.js", - "types": "lib/types.d.ts", + "types": "lib/index.d.ts", "files": [ "lib/", "dist/"