pure-parse/dist/guards/oneOf.d.ts

Strongly typed validation library that decouples type aliases from validation logic

import { Guard } from './Guard';
/**
 * Executes `guards` in order and returns true if any guard matches. The result type is a union.
 * @example
 * Commonly used in discriminated unions:
 * ```ts
 * const isResult = oneOfGuard([
 *  objectGuard({
 *    tag: equalsGuard('success')
 *  }),
 *  objectGuard({
 *    tag: equalsGuard('error')
 *   }),
 * ])
 * ```
 * @example
 * When explicitly annotating `oneOfGuard`, provide a tuple of the union members as type argument:
 * ```ts
 * const isId = oneOfGuard<[string, number]>(isString, isNumber)
 * ```
 * Due to a limitation of TypeScript, it is not possible to write `unionGuard<string | number>()` or `equalsGuard<'red' | 'green' | 'blue'>()`. Therefore, it is generally recommended to omit the type arguments for union types and let TypeScript infer them.
 * @param guards any of these guard functions must match the data.
 * @return a guard function that validates unions
 */
export declare const oneOfGuard: <T extends readonly [...unknown[]]>(...guards: { [K in keyof T]: Guard<T[K]>; }) => (data: unknown) => data is T[number];