@tsed/schema/lib/types/domain/JsonFormatTypes.d.ts

JsonSchema module for Ts.ED Framework

/**
 * Standard JSON Schema format types for string validation.
 *
 * These format types provide semantic validation for string values beyond basic
 * pattern matching. They are part of the JSON Schema specification and widely
 * supported by validation libraries.
 *
 * ### Date and Time Formats
 * - **DATE_TIME**: RFC 3339 date-time (e.g., "2024-01-15T10:30:00Z")
 * - **DATE**: RFC 3339 full-date (e.g., "2024-01-15")
 * - **TIME**: RFC 3339 full-time (e.g., "10:30:00")
 *
 * ### Network Formats
 * - **EMAIL**: Email address (RFC 5322)
 * - **HOSTNAME**: Internet hostname (RFC 1123)
 * - **IPV4**: IPv4 address
 * - **IPV6**: IPv6 address
 * - **URI**: Uniform Resource Identifier (RFC 3986)
 * - **URL**: URL variant of URI
 * - **URI_REF**: URI reference
 * - **URI_TEMPLATE**: URI template (RFC 6570)
 *
 * ### Other Formats
 * - **JSON_POINTER**: JSON Pointer (RFC 6901)
 * - **RELATIVE_JSON_POINTER**: Relative JSON Pointer
 * - **UUID**: Universally Unique Identifier (RFC 4122)
 * - **REGEX**: Regular expression (ECMA-262)
 *
 * ### Usage
 *
 * ```typescript
 * import {JsonFormatTypes} from "@tsed/schema";
 *
 * schema.format(JsonFormatTypes.EMAIL);
 * schema.format(JsonFormatTypes.DATE_TIME);
 * ```
 *
 * @public
 */
export declare enum JsonFormatTypes {
    DATE_TIME = "date-time",
    DATE = "date",
    TIME = "time",
    EMAIL = "email",
    HOSTNAME = "hostname",
    IPV4 = "ipv4",
    IPV6 = "ipv6",
    URI = "uri",
    URL = "url",
    URI_REF = "uri-reference",
    URI_TEMPLATE = "uri-template",
    JSON_POINTER = "json-pointer",
    RELATIVE_JSON_POINTER = "relative-json-pointer",
    UUID = "uuid",
    REGEX = "regex"
}