Class UnionType

Represents an union type.

let value: string | string[];

Hierarchy (View Summary, Expand)

Models.Type
- UnionType

Index

Constructors

constructor

new UnionType(types: Models.SomeType[]): Models.UnionType
Parameters
- types: Models.SomeType[]
Returns Models.UnionType
Overrides Type.constructor
- Defined in lib/models/types.ts:1390

Methods

estimatePrintWidth

estimatePrintWidth(): number
Return the estimated size of the type if it was all printed on one line.

Returns number
Inherited from Type.estimatePrintWidth
- Defined in lib/models/types.ts:67

fromObject

fromObject(de: Deserializer, obj: JSONOutput.UnionType): void
Parameters
- de: Deserializer
- obj: JSONOutput.UnionType
Returns void
Overrides Type.fromObject
- Defined in lib/models/types.ts:1430

`Protected`getTypeString

getTypeString(): string
Implementation method for toString. needsParenthesis will be used to determine if the returned string should be wrapped in parenthesis.

Returns string
Overrides Type.getTypeString
- Defined in lib/models/types.ts:1394

needsParenthesis

needsParenthesis(context: Models.TypeContext): boolean
Parameters
- context: Models.TypeContext
Returns boolean
Overrides Type.needsParenthesis
- Defined in lib/models/types.ts:1400

stringify

stringify(context: Models.TypeContext): string
Parameters
- context: Models.TypeContext
Returns string
Inherited from Type.stringify
- Defined in lib/models/types.ts:44

toObject

toObject(serializer: Serializer): JSONOutput.UnionType
Parameters
- serializer: Serializer
Returns JSONOutput.UnionType
Overrides Type.toObject
- Defined in lib/models/types.ts:1436

toString

toString(): string
Return a string representation of this type.

Returns string
Inherited from Type.toString
- Defined in lib/models/types.ts:25

visit

visit<T, A extends any[] = []>(visitor: Models.TypeVisitor<T, A>, ...args: A): T
Visit this type, returning the value returned by the visitor.
Type Parameters
- T
- A extends any[] = []
Parameters
- visitor: Models.TypeVisitor<T, A>
- ...args: A
Returns T
Inherited from Type.visit
- Defined in lib/models/types.ts:32
visit<T, A extends any[] = []>(
visitor: Partial<Models.TypeVisitor<T, A>>,
...args: A,
): undefined | T
Visit this type, returning the value returned by the visitor.
Type Parameters
- T
- A extends any[] = []
Parameters
- visitor: Partial<Models.TypeVisitor<T, A>>
- ...args: A
Returns undefined | T
Inherited from Type.visit
- Defined in lib/models/types.ts:33

Properties

`Readonly`type

type: "union"

The type name identifier.

types

types: Models.SomeType[]

`Optional`elementSummaries

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.

Class UnionType

Hierarchy (View Summary, Expand)

Index

Constructors

Methods

Properties

Constructors

constructor

Parameters

Returns Models.UnionType

Methods

estimatePrintWidth

Returns number

fromObject

Parameters

Returns void

ProtectedgetTypeString

Returns string

needsParenthesis

Parameters

Returns boolean

stringify

Parameters

Returns string

toObject

Parameters

Returns JSONOutput.UnionType

toString

Returns string

visit

Type Parameters

Parameters

Returns T

Type Parameters

Parameters

Returns undefined | T

Properties

Readonlytype

types

OptionalelementSummaries

Settings

On This Page

`Protected`getTypeString

`Readonly`type

`Optional`elementSummaries