bguard/lib/asserts/string/upperCase.d.mts

**bguard** is a powerful, flexible, and type-safe validation library for TypeScript. It allows developers to define validation schemas for their data structures and ensures that data conforms to the expected types and constraints.

import { RequiredValidation } from '../../core.mjs';
import '../../commonTypes.mjs';
import '../../InferType.mjs';
import '../../helpers/constants.mjs';

/**
 * @description Asserts that a string value is entirely in uppercase.
 * @returns {RequiredValidation} A validation function that takes a received string and an exception context.
 * @throws {ValidationError} if the received value is not in uppercase.
 * @example
 * const schema = string().custom(upperCase());
 * parseOrFail(schema, 'VALID');    // Valid
 * parseOrFail(schema, 'INVALID');  // Throws an error: 'The received value is not in uppercase'
 * parseOrFail(schema, 'Valid');    // Throws an error: 'The received value is not in uppercase'
 *
 * @translation Error Translation Key = 's:upperCase'
 */
declare const upperCase: {
    (): RequiredValidation;
    key: string;
    message: string;
};

export { upperCase };