Class UnionType

Represents an union type.

let value: string | string[];

Hierarchy (view full)

Constructors

constructor

Properties

type types elementSummaries?

Methods

fromObject getTypeString needsParenthesis stringify toObject toString visit

Constructors

constructor

Properties

Readonlytype

type = "union"

The type name identifier.

types

types: Models.SomeType[]

OptionalelementSummaries

elementSummaries?: Models.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.

Methods

fromObject

ProtectedgetTypeString

  • getTypeString(): string

  • Implementation method for toString. needsParenthesis will be used to determine if the returned string should be wrapped in parenthesis.

    Returns string

needsParenthesis

stringify

toObject

toString

visit

Settings

Member Visibility

On This Page

Constructors
Properties
Methods