shapeit/types/guards/literal.d.ts

Object validation tools for Javascript and, specially, Typescript

import { Template, Concat } from '../types/literals';
/**
 * Creates a guard for a template literal type
 *
 * @example
 * const idTemplate = sp.literal('id-', sp.$('bigint'));
 *
 * if (idTemplate(input)) {
 *   input; // input is typed as `id-${bigint}`
 * }
 */
export default function literal<T extends Template>(...template: T): import("..").Guard<Concat<T>> & import("../types/literals").LiteralDescriptor<Concat<T>>;