shapeit/types/guards/is.d.ts

Object validation tools for Javascript and, specially, Typescript

import { FromPrimitive, Primitive } from '../types/utils';
/**
 * Basic Guard creator from a primitive name.
 *
 * @example
 * const isString = is('string');
 *
 * if (isString(value)) {
 *     doSomethingWith(value); // value is typed as string
 * }
 * else {
 *     console.error(isString.errors); // Errors found
 * }
 */
export default function is<T extends Primitive>(target: T): import("..").Guard<FromPrimitive<T>>;