@lou.codes/parsers/dist/parseJSON.d.ts

👁️‍🗨️ Parsers without nonsense

import type { JSONValue } from "@lou.codes/types";
/**
 * Safely parses a JSON string or returns `undefined` if is invalid.
 *
 * @category JSON
 * @remarks
 * `JSON.parse` is unsafe by default, allowing __proto__ poisoning. This
 * function takes care of it while making its types safer as well.
 * @example
 * ```typescript
 * parseJSON('{"__proto__":"😈"}'); // {}
 * parseJSON("invalid"); // undefined
 * ```
 * @see {@link attempt}
 * @see {@link omitProtoReviver}
 *
 * @template Output Generic of the output (has to be a `JSONValue`).
 * @param string String to be parsed.
 * @returns Parsed string or `undefined` if invalid JSON.
 */
export declare const parseJSON: <Output extends JSONValue = JSONValue>(
	string: string,
) => import("@lou.codes/types").Maybe<Output>;