@typia/website
    Preparing search index...

    Interface IOneOf

    Union type.

    IOneOf represents an union type of the TypeScript (A | B | C).

    For reference, even though your Swagger (or OpenAPI) document has defined anyOf instead of the oneOf, OpenApi forcibly converts it to oneOf type.

    interface IOneOf {
        deprecated?: boolean;
        description?: string;
        discriminator?: ILlmSchemaV3_1.IOneOf.IDiscriminator;
        example?: any;
        examples?: Record<string, any>;
        oneOf: (
            | ILlmSchemaV3_1.IObject
            | ILlmSchemaV3_1.IConstant
            | ILlmSchemaV3_1.IBoolean
            | ILlmSchemaV3_1.IInteger
            | ILlmSchemaV3_1.INumber
            | ILlmSchemaV3_1.IString
            | ILlmSchemaV3_1.IArray
            | ILlmSchemaV3_1.IReference
            | ILlmSchemaV3_1.INull
            | ILlmSchemaV3_1.IUnknown
        )[];
        title?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    deprecated? description? discriminator? example? examples? oneOf title?

    Properties

    deprecated?: boolean

    Whether the type is deprecated or not.

    description?: string

    Detailed description of the schema.

    discriminator?: ILlmSchemaV3_1.IOneOf.IDiscriminator

    Discriminator info of the union type.

    example?: any

    Example value.

    examples?: Record<string, any>

    List of example values as key-value pairs.

    oneOf: (
        | ILlmSchemaV3_1.IObject
        | ILlmSchemaV3_1.IConstant
        | ILlmSchemaV3_1.IBoolean
        | ILlmSchemaV3_1.IInteger
        | ILlmSchemaV3_1.INumber
        | ILlmSchemaV3_1.IString
        | ILlmSchemaV3_1.IArray
        | ILlmSchemaV3_1.IReference
        | ILlmSchemaV3_1.INull
        | ILlmSchemaV3_1.IUnknown
    )[]

    List of the union types.

    title?: string

    Title of the schema.

    Settings

    Member Visibility

    On This Page

    Properties