Documentation
    Preparing search index...

    Interface IMetadataSchema

    Metadata schema representing a TypeScript type's structure.

    IMetadataSchema is typia's internal type representation, capturing full TypeScript type information including unions, optionality, nullability, and type constraints. Used by typia.reflect.schema<T>() for runtime type introspection.

    Type categories:

    Jeongho Nam - https://github.com/samchon

    interface IMetadataSchema {
        aliases: IMetadataSchema.IReference[];
        any: boolean;
        arrays: IMetadataSchema.IReference[];
        atomics: IMetadataSchema.IAtomic[];
        constants: IMetadataSchema.IConstant[];
        escaped: IMetadataSchema.IEscaped | null;
        functions: IMetadataSchema.IFunction[];
        maps: IMetadataSchema.IMap[];
        natives: IMetadataSchema.IReference[];
        nullable: boolean;
        objects: IMetadataSchema.IReference[];
        optional: boolean;
        required: boolean;
        rest: IMetadataSchema | null;
        sets: IMetadataSchema.ISet[];
        templates: IMetadataSchema.ITemplate[];
        tuples: IMetadataSchema.IReference[];
    }
    Index

    Properties

    Type alias references in the union.

    any: boolean

    Whether the type is any.

    Array type references in the union.

    Primitive types (boolean, bigint, number, string) in the union.

    Literal constant values in the union.

    escaped: IMetadataSchema.IEscaped | null

    Escaped type info (original and transformed).

    Function types in the union.

    Map types in the union.

    Native class references (Date, Uint8Array, etc.) in the union.

    nullable: boolean

    Whether the type is nullable (null included).

    Object type references in the union.

    optional: boolean

    Whether the type is optional (? modifier).

    required: boolean

    Whether the type is required (not undefined).

    rest: IMetadataSchema | null

    Rest element type for variadic tuples.

    Set types in the union.

    Template literal types in the union.

    Tuple type references in the union.