shapeit/types/guards/tuple.d.ts

Object validation tools for Javascript and, specially, Typescript

import { PrimitiveOrGuard, UnshapeTuple } from '../types/guards';
/**
 * Creates a guard for a tuple type. The order of the arguments is the same
 * as the type order of the tuple
 *
 * @example
 * const entryShape = sp.tuple('string', 'number');
 *
 * if (entryShape(input)) {
 *   input; // Typed as [string, number]
 * }
 */
export default function tuple<T extends PrimitiveOrGuard<unknown>[]>(...types: T): import("../types/guards").Guard<UnshapeTuple<T>>;