DefinitelyTyped/types/buffer-json/index.d.ts
Ayyan Lewis b1896394f3
Add buffer-json (#43667)
* Add buffer-json

* Create tsconfig.json

* Create buffer-json-tests.ts

* Create tslint.json

* Update buffer-json-tests.ts

* Update index.d.ts

* Update index.d.ts
2020-04-07 08:15:24 -07:00

35 lines
1.3 KiB
TypeScript

// Type definitions for buffer-json 2.0
// Project: https://github.com/jprichardson/buffer-json
// Definitions by: chroventer <https://github.com/chroventer>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
/**
* Converts a JavaScript object or value to a JSON string.
* @param value The value to convert to a JSON string.
* @param space A String or Number object that's used to insert white space into the output JSON string for readability purposes.
* @return A JSON string representing the given value.
*/
export function stringify(value: any, space?: string | number): string;
/**
* Parses a JSON 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 JSON.
* @return The `Object` corresponding to the given JSON text.
*/
export function parse(text: string): any;
/**
* A function that transform the value computed by parsing before being returned.
* @param key
* @param value
*/
export function replacer(key: string, value: string): any;
/**
* A function that alters the behavior of the stringification process.
* @param key
* @param value
*/
export function reviver(key: string, value: any): any;