@web3r/flowerkit/dist/json/getJSONFromStr/index.d.mts

Tree-shakable JavaScript and TypeScript utility library for frontend/browser apps: DOM, events, arrays, objects, strings, date, JSON, and network helpers (ESM/CJS, SSR-friendly).

export type TGetJSONFromStrArgs = Parameters<typeof getJSONFromStr>;
export type TGetJSONFromStrReturn = ReturnType<typeof getJSONFromStr>;
/**
 * Safely parses a JSON string.
 *
 * @template T
 * @param {string} str Source string to parse
 * @param {(this: any, key: string, value: any) => any} [reviver] Optional reviver function
 * @param {(err: unknown) => void} [onError] Optional error callback
 * @returns {T | Record<string, never>} Parsed object or empty object on error
 * @throws {TypeError} getJSONFromStr: str must be a string
 * @throws {TypeError} getJSONFromStr: reviver must be a function if provided
 * @throws {TypeError} getJSONFromStr: onError must be a function if provided
 * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/parse
 * @example
 * // How to convert string to JSON?
 * const json = getJSONFromStr<{ hello: string }>('{"hello":"world"}');
 * console.log(json.hello); // => "world"
 */
export declare const getJSONFromStr: <T = unknown>(str: string, reviver?: (this: any, key: string, value: any) => any, onError?: (err: unknown) => void) => T | Record<string, never>;