Interface StringProp

interface StringProp {
    $comment?: string;
    default?: any;
    description?: string;
    examples?: any[];
    format:
        | "date-time"
        | "time"
        | "date"
        | "email"
        | "idn-email"
        | "hostname"
        | "idn-hostname"
        | "ipv4"
        | "ipv6"
        | "uri"
        | "uri-reference"
        | "iri"
        | "iri-reference"
        | "uri-template"
        | "json-pointer"
        | "relative-json-pointer"
        | "regex";
    maxLength?: number;
    minLength?: number;
    pattern?: string;
    readOnly?: boolean;
    title?: string;
    type: "string";
}

Hierarchy (View Summary)

Properties

$comment?: string

Internal comment

default?: any

Default attribute value

description?: string

Attribute description

examples?: any[]

List of attribute examples

format:
    | "date-time"
    | "time"
    | "date"
    | "email"
    | "idn-email"
    | "hostname"
    | "idn-hostname"
    | "ipv4"
    | "ipv6"
    | "uri"
    | "uri-reference"
    | "iri"
    | "iri-reference"
    | "uri-template"
    | "json-pointer"
    | "relative-json-pointer"
    | "regex"
maxLength?: number
minLength?: number
pattern?: string
readOnly?: boolean

Non-editable schema

title?: string
type: "string"