AutoBE
    Preparing search index...

    Interface IString

    String type info.

    interface IString {
        contentMediaType?: string;
        description: string;
        format?:
            | "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;
        type: "string";
        "x-autobe-database-schema-property"?: string
        | null;
        "x-autobe-required-parent-composition"?: boolean;
        "x-autobe-security"?:
            | "password"
            | "token"
            | "externalCredential"
            | "sensitive"
            | "role"
            | null;
        "x-autobe-specification"?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    contentMediaType? description format? maxLength? minLength? pattern? type x-autobe-database-schema-property? x-autobe-required-parent-composition? x-autobe-security? x-autobe-specification?

    Properties

    contentMediaType?: string

    Content media type restriction.

    For multiple media types, use oneOf with separate string schemas per contentMediaType value. Never use an array here.

    description: string
    format?:
        | "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
    minLength?: number
    pattern?: string

    Pattern restriction.

    type: "string"

    Discriminator value. MUST be a single string, NEVER an array.

    For nullable types, use IOneOf instead: { oneOf: [{ type: "string" }, { type: "null" }] }

    "x-autobe-database-schema-property"?: string | null
    "x-autobe-required-parent-composition"?: boolean

    true when the interface composition marker pass stamped this nested *.ICreate property as a required parent composition (AutoBeDatabase.IParentComposition with presence: "required") that the parent's create/IJoin body must co-create. A producer-asserted structural marker so realize detects the children to co-create by it instead of by the referenced DTO's name; absent/false for every other property, including optional compositions.

    "x-autobe-security"?:
        | "password"
        | "token"
        | "externalCredential"
        | "sensitive"
        | "role"
        | null

    Field-level security classification propagated from the mapped database column (AutoBeDatabase.IPlainField.security); null/absent for an ordinary column or a property with no database column. Inline literal by contract — never aliased to a named type.

    "x-autobe-specification"?: string

    Settings

    Member Visibility

    On This Page

    Properties