safers/dist/types/primitive/parse.d.ts

Safely convert to the desired data and error-free refine values.

/**
 * Parses a JSON string into an object or returns a default object if parsing fails or the input is not a string.
 *
 * @param val - The value to be parsed (should be a string containing JSON data).
 * @param def - The default object returned if parsing fails or the input is not a string (optional).
 * @returns The parsed JSON object if successful, otherwise the default object.
 *
 * @remarks
 * - If `val` is a valid JSON string, it will be parsed into an object.
 * - If `val` is not a string or an error occurs during parsing, the function returns the default object `def`.
 *
 * @example
 * ```ts
 * parse('{"name":"John","age":23}'); // { name: "John", age: 23 }
 * parse('{"name":"John","age":23}', { name: "Jane", age: 21 }); // { name: "John", age: 23 }
 * parse(null); // {}
 * parse(null, { name: "Jane", age: 21 }); // { name: "Jane", age: 21 }
 * ```
 */
export declare function parse(val: unknown, def?: {}): any;