valibot-schema-roman-numerals/dist/index.d.ts

Valibot schema for Roman numerals

import { CustomIssue, CustomSchema, ErrorMessage, InferOutput } from 'valibot';

/**
 * A schema for validating Roman numerals.
 * @module
 */

/**
 * Function to validate roman numerals.
 * @param overrideMessage - A string to override the default message or a callback to define a custom message function.
 * @returns A custom schema for roman numeral validation.
 */
declare const romanNumeral: (overrideMessage?: string | ((value: CustomIssue) => string)) => CustomSchema<string, ErrorMessage<CustomIssue>>;
/**
 * Type for the output of the roman numeral schema.
 * @typedef {InferOutput<ReturnType<typeof romanNumeral>>} RomanNumeralSchema
 */
type RomanNumeralSchema = InferOutput<ReturnType<typeof romanNumeral>>;

export { type RomanNumeralSchema, romanNumeral };