TypeDoc API - v0.28.2

    Interface UnionType

    interface UnionType {
        type: "union";
        types: JSONOutput.SomeType[];
        elementSummaries?: JSONOutput.CommentDisplayPart[][];
    }

    Hierarchy (View Summary, Expand)

    Index

    Properties

    type types elementSummaries?

    Properties

    type: "union"

    The type name identifier.

    types: JSONOutput.SomeType[]
    elementSummaries?: JSONOutput.CommentDisplayPart[][]

    If present, there should be as many items in this array as there are items in the types array.

    This member is only valid on unions which are on DeclarationReflection.type with a ReflectionKind kind of TypeAlias. Specifying it on any other union is undefined behavior.

    Settings

    Member Visibility

    On This Page

    Properties
    MMNEPVFCICPMFPCPTTAAATR