Class OptionalType

Represents an optional type

type Z = [1, 2?]
//           ^^

Hierarchy

Type
- OptionalType

Index

Constructors

constructor

new OptionalType(elementType: SomeType): OptionalType
Parameters
- elementType: SomeType
Returns OptionalType
Overrides Type.constructor
- Defined in src/lib/models/types.ts:629

Properties

elementType

elementType: SomeType

`Readonly` type

type: "optional" = "optional"

The type name identifier.

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:634

needsParenthesis

needsParenthesis(): boolean
Returns boolean
Overrides Type.needsParenthesis
- Defined in src/lib/models/types.ts:638

stringify

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

toObject

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

toString

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

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

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:28
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:29

Class OptionalType

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

elementType: SomeType

Returns OptionalType

Properties

elementType

Readonly type

Methods

Protected getTypeString

Returns string

needsParenthesis

Returns boolean

stringify

Parameters

context: TypeContext

Returns string

toObject

Parameters

serializer: Serializer

Returns JSONOutput.OptionalType

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