String type info.

interface IString {
    contentMediaType?: string;
    default?: string;
    deprecated?: boolean;
    description?: string;
    example?: any;
    examples?: Record<string, any>;
    format?:
        | string & {}
        | "binary"
        | "byte"
        | "password"
        | "regex"
        | "uuid"
        | "email"
        | "hostname"
        | "idn-email"
        | "idn-hostname"
        | "iri"
        | "iri-reference"
        | "ipv4"
        | "ipv6"
        | "uri"
        | "uri-reference"
        | "uri-template"
        | "url"
        | "date-time"
        | "date"
        | "time"
        | "duration"
        | "json-pointer"
        | "relative-json-pointer";
    maxLength?: number;
    minLength?: number;
    pattern?: string;
    title?: string;
    type: "string";
}

Hierarchy (View Summary)

Properties

contentMediaType?: string

Content media type restriction.

default?: string

Default value.

deprecated?: boolean

Whether the type is deprecated or not.

description?: string

Detailed description of the schema.

example?: any

Example value.

examples?: Record<string, any>

List of example values as key-value pairs.

format?:
    | string & {}
    | "binary"
    | "byte"
    | "password"
    | "regex"
    | "uuid"
    | "email"
    | "hostname"
    | "idn-email"
    | "idn-hostname"
    | "iri"
    | "iri-reference"
    | "ipv4"
    | "ipv6"
    | "uri"
    | "uri-reference"
    | "uri-template"
    | "url"
    | "date-time"
    | "date"
    | "time"
    | "duration"
    | "json-pointer"
    | "relative-json-pointer"

Format restriction.

maxLength?: number

Maximum length restriction.

minLength?: number

Minimum length restriction.

pattern?: string

Pattern restriction.

title?: string

Title of the schema.

type: "string"

Discriminator value of the type.