Class UnionType

Represents an union type.

let value: string | string[];

Hierarchy

Type
- UnionType

Index

Constructors

constructor

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

Properties

`Readonly` type

type: "union" = "union"

The type name identifier.

types

types: SomeType[]

Methods

`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 src/lib/models/types.ts:1205

needsParenthesis

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

stringify

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

toObject

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

toString

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

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

visit

visit<T>(visitor: TypeVisitor<T>): T
Visit this type, returning the value returned by the visitor.
Type Parameters
- T
Parameters
- visitor: TypeVisitor<T>
Returns T
Inherited from Type.visit
- Defined in src/lib/models/types.ts:29
visit<T>(visitor: Partial<TypeVisitor<T>>): undefined | T
Type Parameters
- T
Parameters
- visitor: Partial<TypeVisitor<T>>
Returns undefined | T
Inherited from Type.visit
- Defined in src/lib/models/types.ts:30

Class UnionType

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

types: SomeType[]

Returns UnionType

Properties

Readonly type

types

Methods

Protected getTypeString

Returns string

needsParenthesis

Parameters

context: TypeContext

Returns boolean

stringify

Parameters

context: TypeContext

Returns string

toObject

Parameters

serializer: Serializer

Returns JSONOutput.UnionType

toString

Returns string

visit

Type Parameters

T

Parameters

visitor: TypeVisitor<T>

Returns T

Type Parameters

T

Parameters

visitor: Partial<TypeVisitor<T>>

Returns undefined | T

Settings

Member Visibility

Theme

`Readonly` type

`Protected` getTypeString