@settlemint/sdk-utils/dist/json.d.ts

Shared utilities and helper functions for SettleMint SDK modules

//#region src/json.d.ts
/**
 * Attempts to parse a JSON string into a typed value, returning a default value if parsing fails.
 *
 * @param value - The JSON string to parse
 * @param defaultValue - The value to return if parsing fails or results in null/undefined
 * @returns The parsed JSON value as type T, or the default value if parsing fails
 *
 * @example
 * import { tryParseJson } from "@settlemint/sdk-utils";
 *
 * const config = tryParseJson<{ port: number }>(
 *   '{"port": 3000}',
 *   { port: 8080 }
 * );
 * // Returns: { port: 3000 }
 *
 * const invalid = tryParseJson<string[]>(
 *   'invalid json',
 *   []
 * );
 * // Returns: []
 */
declare function tryParseJson<T>(value: string, defaultValue?: T | null): T | null;
/**
 * Extracts a JSON object from a string.
 *
 * @param value - The string to extract the JSON object from
 * @returns The parsed JSON object, or null if no JSON object is found
 * @throws {Error} If the input string is too long (longer than 5000 characters)
 * @example
 * import { extractJsonObject } from "@settlemint/sdk-utils";
 *
 * const json = extractJsonObject<{ port: number }>(
 *   'port info: {"port": 3000}',
 * );
 * // Returns: { port: 3000 }
 */
declare function extractJsonObject<T>(value: string): T | null;
/**
 * Converts a value to a JSON stringifiable format.
 *
 * @param value - The value to convert
 * @returns The JSON stringifiable value
 *
 * @example
 * import { makeJsonStringifiable } from "@settlemint/sdk-utils";
 *
 * const json = makeJsonStringifiable<{ amount: bigint }>({ amount: BigInt(1000) });
 * // Returns: '{"amount":"1000"}'
 */
declare function makeJsonStringifiable<T>(value: unknown): T;
//#endregion
export { extractJsonObject, makeJsonStringifiable, tryParseJson };
//# sourceMappingURL=json.d.ts.map