-
-
Notifications
You must be signed in to change notification settings - Fork 17
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
57 additions
and
48 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,48 +1,57 @@ | ||
export type ParseOptions = { | ||
type Parse = typeof parse | ||
|
||
declare namespace parse { | ||
export type ParseOptions = { | ||
/** | ||
* What to do when a `__proto__` key is found. | ||
* - `'error'` - throw a `SyntaxError` when a `__proto__` key is found. This is the default value. | ||
* - `'remove'` - deletes any `__proto__` keys from the result object. | ||
* - `'ignore'` - skips all validation (same as calling `JSON.parse()` directly). | ||
*/ | ||
protoAction?: 'error' | 'remove' | 'ignore'; | ||
/** | ||
* What to do when a `constructor` key is found. | ||
* - `'error'` - throw a `SyntaxError` when a `constructor.prototype` key is found. This is the default value. | ||
* - `'remove'` - deletes any `constructor` keys from the result object. | ||
* - `'ignore'` - skips all validation (same as calling `JSON.parse()` directly). | ||
*/ | ||
constructorAction?: 'error' | 'remove' | 'ignore'; | ||
} | ||
|
||
export type ScanOptions = ParseOptions | ||
|
||
export type Reviver = (this: any, key: string, value: any) => any | ||
|
||
/** | ||
* Parses a given JSON-formatted text into an object. | ||
* | ||
* @param text The JSON text string. | ||
* @param reviver The `JSON.parse()` optional `reviver` argument. | ||
* @param options Optional configuration object. | ||
* @returns The parsed object. | ||
*/ | ||
export const parse: Parse | ||
|
||
/** | ||
* What to do when a `__proto__` key is found. | ||
* - `'error'` - throw a `SyntaxError` when a `__proto__` key is found. This is the default value. | ||
* - `'remove'` - deletes any `__proto__` keys from the result object. | ||
* - `'ignore'` - skips all validation (same as calling `JSON.parse()` directly). | ||
*/ | ||
protoAction?: 'error' | 'remove' | 'ignore'; | ||
* Parses a given JSON-formatted text into an object. | ||
* | ||
* @param text The JSON text string. | ||
* @param reviver The `JSON.parse()` optional `reviver` argument. | ||
* @returns The parsed object, or `null` if there was an error or if the JSON contained possibly insecure properties. | ||
*/ | ||
export function safeParse(text: string | Buffer, reviver?: Reviver | null): any | ||
|
||
/** | ||
* What to do when a `constructor` key is found. | ||
* - `'error'` - throw a `SyntaxError` when a `constructor.prototype` key is found. This is the default value. | ||
* - `'remove'` - deletes any `constructor` keys from the result object. | ||
* - `'ignore'` - skips all validation (same as calling `JSON.parse()` directly). | ||
* Scans a given object for prototype properties. | ||
* | ||
* @param obj The object being scanned. | ||
* @param options Optional configuration object. | ||
* @returns The object, or `null` if onError is set to `nullify` | ||
*/ | ||
constructorAction?: 'error' | 'remove' | 'ignore'; | ||
export function scan(obj: { [key: string | number]: any }, options?: ParseOptions): any | ||
|
||
export { parse as default} | ||
} | ||
|
||
export type ScanOptions = ParseOptions | ||
|
||
type Reviver = (this: any, key: string, value: any) => any | ||
|
||
/** | ||
* Parses a given JSON-formatted text into an object. | ||
* | ||
* @param text The JSON text string. | ||
* @param reviver The `JSON.parse()` optional `reviver` argument. | ||
* @param options Optional configuration object. | ||
* @returns The parsed object. | ||
*/ | ||
export function parse(text: string | Buffer, reviver?: Reviver | null, options?: ParseOptions): any | ||
|
||
/** | ||
* Parses a given JSON-formatted text into an object. | ||
* | ||
* @param text The JSON text string. | ||
* @param reviver The `JSON.parse()` optional `reviver` argument. | ||
* @returns The parsed object, or `null` if there was an error or if the JSON contained possibly insecure properties. | ||
*/ | ||
export function safeParse(text: string | Buffer, reviver?: Reviver | null): any | ||
|
||
/** | ||
* Scans a given object for prototype properties. | ||
* | ||
* @param obj The object being scanned. | ||
* @param options Optional configuration object. | ||
* @returns The object, or `null` if onError is set to `nullify` | ||
*/ | ||
export function scan(obj: {[key: string | number]: any }, options?: ParseOptions): any | ||
declare function parse(text: string | Buffer, reviver?: parse.Reviver | null, options?: parse.ParseOptions): any | ||
export = parse |