Class OptionalType

Represents an optional type

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

Hierarchy (View Summary)

Models.Type
- OptionalType

Index

Constructors

constructor

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

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.SomeType): void
Parameters
- _de: Deserializer
- _obj: JSONOutput.SomeType
Returns void
Inherited from Type.fromObject
- Defined in lib/models/types.ts:54

`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:671

needsParenthesis

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

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.OptionalType
Parameters
- serializer: Serializer
Returns JSONOutput.OptionalType
Overrides Type.toObject
- Defined in lib/models/types.ts:679

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

elementType

elementType: Models.SomeType

`Readonly`type

type: "optional"

The type name identifier.

Class OptionalType

Hierarchy (View Summary)

Index

Constructors

Methods

Properties

Constructors

constructor

Parameters

Returns Models.OptionalType

Methods

estimatePrintWidth

Returns number

fromObject

Parameters

Returns void

`Protected`getTypeString

Returns string

needsParenthesis

Returns boolean

stringify

Parameters

Returns string

toObject

Parameters

Returns JSONOutput.OptionalType

toString

Returns string

visit

Type Parameters

Parameters

Returns T

Type Parameters

Parameters

Returns undefined | T

Properties

elementType

`Readonly`type

Settings

On This Page

Class OptionalType

Hierarchy (View Summary)

Index

Constructors

Methods

Properties

Constructors

constructor

Parameters

Returns Models.OptionalType

Methods

estimatePrintWidth

Returns number

fromObject

Parameters

Returns void

ProtectedgetTypeString

Returns string

needsParenthesis

Returns boolean

stringify

Parameters

Returns string

toObject

Parameters

Returns JSONOutput.OptionalType

toString

Returns string

visit

Type Parameters

Parameters

Returns T

Type Parameters

Parameters

Returns undefined | T

Properties

elementType

Readonlytype

Settings

On This Page

`Protected`getTypeString

`Readonly`type