Class TupleType

Represents a tuple type.

let value: [string, boolean];

Hierarchy (View Summary, Expand)

Models.Type
- TupleType

Index

Constructors

constructor

new TupleType(elements: Models.SomeType[]): Models.TupleType
Parameters
- elements: Models.SomeType[]
  The ordered type elements of the tuple type.
Returns Models.TupleType
Overrides Type.constructor
- Defined in lib/models/types.ts:1239

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

needsParenthesis

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

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

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

elements

elements: Models.SomeType[]

The ordered type elements of the tuple type.

`Readonly`type

type: "tuple"

The type name identifier.

Class TupleType

Hierarchy (View Summary, Expand)

Index

Constructors

Methods

Properties

Constructors

constructor

Parameters

Returns Models.TupleType

Methods

estimatePrintWidth

Returns number

fromObject

Parameters

Returns void

`Protected`getTypeString

Returns string

needsParenthesis

Returns boolean

stringify

Parameters

Returns string

toObject

Parameters

Returns JSONOutput.TupleType

toString

Returns string

visit

Type Parameters

Parameters

Returns T

Type Parameters

Parameters

Returns undefined | T

Properties

elements

`Readonly`type

Settings

On This Page

Class TupleType

Hierarchy (View Summary, Expand)

Index

Constructors

Methods

Properties

Constructors

constructor

Parameters

Returns Models.TupleType

Methods

estimatePrintWidth

Returns number

fromObject

Parameters

Returns void

ProtectedgetTypeString

Returns string

needsParenthesis

Returns boolean

stringify

Parameters

Returns string

toObject

Parameters

Returns JSONOutput.TupleType

toString

Returns string

visit

Type Parameters

Parameters

Returns T

Type Parameters

Parameters

Returns undefined | T

Properties

elements

Readonlytype

Settings

On This Page

`Protected`getTypeString

`Readonly`type