Class ConditionalType

Represents a conditional type.

let value: Check extends Extends ? True : False;

Hierarchy (View Summary, Expand)

Models.Type
- ConditionalType

Index

Constructors

constructor

new ConditionalType(
    checkType: Models.SomeType,
    extendsType: Models.SomeType,
    trueType: Models.SomeType,
    falseType: Models.SomeType,
): Models.ConditionalType
Parameters
- checkType: Models.SomeType
- extendsType: Models.SomeType
- trueType: Models.SomeType
- falseType: Models.SomeType
Returns Models.ConditionalType
Overrides Type.constructor
- Defined in lib/models/types.ts:277

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

needsParenthesis

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

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

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

checkType

checkType: Models.SomeType

extendsType

extendsType: Models.SomeType

falseType

falseType: Models.SomeType

trueType

trueType: Models.SomeType

`Readonly`type

type: "conditional"

The type name identifier.

Class ConditionalType

Hierarchy (View Summary, Expand)

Index

Constructors

Methods

Properties

Constructors

constructor

Parameters

Returns Models.ConditionalType

Methods

estimatePrintWidth

Returns number

fromObject

Parameters

Returns void

ProtectedgetTypeString

Returns string

needsParenthesis

Parameters

Returns boolean

stringify

Parameters

Returns string

toObject

Parameters

Returns JSONOutput.ConditionalType

toString

Returns string

visit

Type Parameters

Parameters

Returns T

Type Parameters

Parameters

Returns undefined | T

Properties

checkType

extendsType

falseType

trueType

Readonlytype

Settings

On This Page

`Protected`getTypeString

`Readonly`type