Class InferredType

Represents an inferred type, U in the example below.

type Z = Promise<string> extends Promise<infer U> : never

Hierarchy (View Summary, Expand)

Models.Type
- InferredType

Index

Constructors

constructor

new InferredType(
name: string,
constraint?: Models.SomeType,
): Models.InferredType
Parameters
- name: string
- Optionalconstraint: Models.SomeType
Returns Models.InferredType
Overrides Type.constructor
- Defined in lib/models/types.ts:386

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

needsParenthesis

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

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

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

name

name: string

`Readonly`type

type: "inferred"

The type name identifier.

`Optional`constraint

constraint?: Models.SomeType

Class InferredType

Hierarchy (View Summary, Expand)

Index

Constructors

Methods

Properties

Constructors

constructor

Parameters

Returns Models.InferredType

Methods

estimatePrintWidth

Returns number

fromObject

Parameters

Returns void

ProtectedgetTypeString

Returns string

needsParenthesis

Parameters

Returns boolean

stringify

Parameters

Returns string

toObject

Parameters

Returns JSONOutput.InferredType

toString

Returns string

visit

Type Parameters

Parameters

Returns T

Type Parameters

Parameters

Returns undefined | T

Properties

name

Readonlytype

Optionalconstraint

Settings

On This Page

`Protected`getTypeString

`Readonly`type

`Optional`constraint