pure-parse/dist/memoization/memo.d.ts

Strongly typed validation library that decouples type aliases from validation logic

import { Parser } from '../parsers';
import { Guard } from '../guards';
/**
 * Memoizes a validator function—a parser or a guard.
 * Internally, a memoized function uses a [WeakMap](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/WeakMap) to prevent memory leaks.
 * While you can wrap any validator function within `memo`, primitive values will not be memoized.
 * @example
 * const parseUser = memo(object({
 *  id: parseNumber,
 *  name: parseString,
 * }))
 * @example
 * It can be used to for nested properties
 * ```ts
 * const parseUser = object({
 *   id: parseNumber,
 *   name: parseString,
 *   address: memo(object({
 *     street: parseString,
 *     city: parseString,
 *   })),
 * })
 * ```
 * @param validator A parser or guard function.
 * @returns A memoized version of `validator`.
 */
export declare const memo: <T extends (arg: unknown) => unknown>(validator: T) => T;
/**
 * Given a higher order function that constructs a validator, returns a new function that also constructs a validator, but the validator will be memoized.
 * @example
 * const objectMemo = memo2(object)
 * const parseUser = objectMemo({
 *  id: parseNumber,
 *  name: parseString,
 * })
 * @param validatorConstructor A higher order function that takes a schema and constructs a validator—a parser or a guard.
 * @returns A function of the same type of `validatorConstructor`, but when called, the returned function is memoized.
 */
export declare const memoizeValidatorConstructor: <T extends (...schema: never[]) => Parser<unknown> | Guard<unknown>>(validatorConstructor: T) => T;