AutoBE
    Preparing search index...

    Interface IString

    String type info.

    interface IString {
        contentMediaType?: string;
        format?:
            | "url"
            | "password"
            | "regex"
            | "uuid"
            | "email"
            | "hostname"
            | "idn-email"
            | "idn-hostname"
            | "iri"
            | "iri-reference"
            | "ipv4"
            | "ipv6"
            | "uri"
            | "uri-reference"
            | "uri-template"
            | "date-time"
            | "date"
            | "time"
            | "duration"
            | "json-pointer"
            | "relative-json-pointer";
        maxLength?: number;
        minLength?: number;
        pattern?: string;
        type: "string";
    }

    Hierarchy (View Summary)

    Index

    Properties

    contentMediaType? format? maxLength? minLength? pattern? type

    Properties

    contentMediaType?: string

    Content media type restriction.

    If you want to accept multiple contentMediaType values simultaneously (e.g., text/plain and text/html), you MUST NOT violate the type by using an array. Instead, use oneOf to define multiple string schemas with different contentMediaType values.

    Example for accepting both text/plain and text/html:

    {
      "oneOf": [
        { "type": "string", "contentMediaType": "text/plain" },
        { "type": "string", "contentMediaType": "text/html" }
      ]
    }

    This is the CORRECT approach. Never use array notation or modify the single string type to accept arrays.

    format?:
        | "url"
        | "password"
        | "regex"
        | "uuid"
        | "email"
        | "hostname"
        | "idn-email"
        | "idn-hostname"
        | "iri"
        | "iri-reference"
        | "ipv4"
        | "ipv6"
        | "uri"
        | "uri-reference"
        | "uri-template"
        | "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.

    type: "string"

    Discriminator value of the type.

    CRITICAL: This MUST be a SINGLE string value, NOT an array. The type field identifies the JSON Schema type and must be exactly one of: "boolean", "integer", "number", "string", "array", "object", or "null".

    ❌ INCORRECT: type: ["string", "null"] // This is WRONG! ✅ CORRECT: type: "string" // For nullable string, use oneOf instead

    If you need to express a nullable type (e.g., string | null), you MUST use the IOneOf structure:

    {
      "oneOf": [{ "type": "string" }, { "type": "null" }]
    }

    NEVER use array notation in the type field. The type field is a discriminator that accepts only a single string value.

    Settings

    Member Visibility

    On This Page

    Properties