object-shape-tester/dist/util/json.d.ts

Test object properties and value types.

import { type CheckShapeOptions } from '../shape/check-shape.js';
import { type Shape } from '../shape/shape.js';
/**
 * Parse a JSON string and verify it against the given shape definition. Also handles top level
 * empty strings and `'undefined'` (both are converted to `undefined`).
 *
 * @category Util
 * @example
 *
 * ```ts
 * import {parseJsonWithShape, defineShape} from 'object-shape-tester';
 *
 * const result = parseJsonWithShape('{"a": "hello"}', defineShape({a: ''}));
 * ```
 *
 * @throws If the parsed JSON does not match the shape definition or if the JSON parsing throws an
 *   error.
 */
export declare function parseJsonWithShape<const CurrentShape extends Shape>(json: string, shape: Readonly<CurrentShape>, options?: CheckShapeOptions, failureMessage?: string | undefined): CurrentShape['runtimeType'];
/**
 * Read and parse a JSON file and verify its contents against the given shape definition. Also
 * handles top level empty strings and `'undefined'` (both are converted to `undefined`).
 *
 * This will only work when run in a server / Node.js environment.
 *
 * @category Util
 * @example
 *
 * ```ts
 * import {readJsonWithShape, defineShape} from 'object-shape-tester';
 *
 * const result = readJsonWithShape('./my-file.json', defineShape({a: ''}));
 * ```
 *
 * @throws If the parsed JSON does not match the shape definition or if the JSON parsing throws an
 *   error.
 */
export declare function readJsonWithShape<const CurrentShape extends Shape>(filePath: string, shape: Readonly<CurrentShape>, options?: CheckShapeOptions, failureMessage?: string | undefined): Promise<CurrentShape["runtimeType"]>;