Class IndexedAccessType

Represents an indexed access type.

Hierarchy (View Summary)

Models.Type
- IndexedAccessType

Index

Constructors

Methods

estimatePrintWidth fromObject getTypeString needsParenthesis stringify toObject toString visit

Properties

indexType objectType type

Constructors

constructor

new IndexedAccessType(
objectType: Models.SomeType,
indexType: Models.SomeType,
): Models.IndexedAccessType
Parameters
- objectType: Models.SomeType
- indexType: Models.SomeType
Returns Models.IndexedAccessType
Overrides Type.constructor
- Defined in lib/models/types.ts:354

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

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

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

needsParenthesis

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

stringify

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

toObject

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

toString

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

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

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:40
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:41

Properties

indexType

indexType: Models.SomeType

objectType

objectType: Models.SomeType

`Readonly`type

type: "indexedAccess"

The type name identifier.