Skip to content

Commit d88d3a4

Browse files
docs(lib): add @throws JSDoc for JSON methods (#61596)
Co-authored-by: Nathan Shively-Sanders <[email protected]>
1 parent 5e36778 commit d88d3a4

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

src/lib/es5.d.ts

+3
Original file line numberDiff line numberDiff line change
@@ -1140,20 +1140,23 @@ interface JSON {
11401140
* @param text A valid JSON string.
11411141
* @param reviver A function that transforms the results. This function is called for each member of the object.
11421142
* If a member contains nested objects, the nested objects are transformed before the parent object is.
1143+
* @throws {SyntaxError} If `text` is not valid JSON.
11431144
*/
11441145
parse(text: string, reviver?: (this: any, key: string, value: any) => any): any;
11451146
/**
11461147
* Converts a JavaScript value to a JavaScript Object Notation (JSON) string.
11471148
* @param value A JavaScript value, usually an object or array, to be converted.
11481149
* @param replacer A function that transforms the results.
11491150
* @param space Adds indentation, white space, and line break characters to the return-value JSON text to make it easier to read.
1151+
* @throws {TypeError} If a circular reference or a BigInt value is found.
11501152
*/
11511153
stringify(value: any, replacer?: (this: any, key: string, value: any) => any, space?: string | number): string;
11521154
/**
11531155
* Converts a JavaScript value to a JavaScript Object Notation (JSON) string.
11541156
* @param value A JavaScript value, usually an object or array, to be converted.
11551157
* @param replacer An array of strings and numbers that acts as an approved list for selecting the object properties that will be stringified.
11561158
* @param space Adds indentation, white space, and line break characters to the return-value JSON text to make it easier to read.
1159+
* @throws {TypeError} If a circular reference or a BigInt value is found.
11571160
*/
11581161
stringify(value: any, replacer?: (number | string)[] | null, space?: string | number): string;
11591162
}

0 commit comments

Comments
 (0)