pure-parse/dist/common/lazy.d.ts

Strongly typed validation library that decouples type aliases from validation logic

/**
 * Creates a lazy-loaded function that initializes the function only when it is called for the first time.
 * With `lazy`, you can create recursive parsers without running into circular dependencies.
 * Also useful to lazily initialize just-in-time compiled parsers and guards.
 * @example
 * Create recursive parsers with `lazy`.
 * Note that you must use explicit type annotations:
 * ```ts
 * import { lazy, type Parser, object, parseString, optional } from 'pure-parse'
 *
 * type Person = {
 *   name: string
 *   father?: Person
 *   mother?: Person
 * }
 * const parsePerson: Parser<Person> = lazy(() =>
 *   object({
 *     name: parseString,
 *     father: optional(parsePerson),
 *     mother: optional(parsePerson),
 *   }),
 * )
 * ```
 * @param constructFn
 */
export declare const lazy: <T extends (...args: never[]) => unknown>(constructFn: () => T) => T;