Class LiteralType

Represents a literal type.

type A = "A"
type B = 1

Hierarchy (View Summary)

Models.Type
- LiteralType

Index

Constructors

constructor

new LiteralType(
value: string | number | bigint | boolean | null,
): Models.LiteralType
Parameters
- value: string | number | bigint | boolean | null
Returns Models.LiteralType
Overrides Type.constructor
- Defined in lib/models/types.ts:545

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
Return a string representation of this type.

Returns string
Overrides Type.getTypeString
- Defined in lib/models/types.ts:552

needsParenthesis

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

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(): JSONOutput.LiteralType
Returns JSONOutput.LiteralType
Overrides Type.toObject
- Defined in lib/models/types.ts:563

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,
): T | undefined
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 T | undefined
Inherited from Type.visit
- Defined in lib/models/types.ts:33

Properties

`Readonly`type

type: "literal"

The type name identifier.

value

value: string | number | bigint | boolean | null

Class LiteralType

Hierarchy (View Summary)

Index

Constructors

Methods

Properties

Constructors

constructor

Parameters

Returns Models.LiteralType

Methods

estimatePrintWidth

Returns number

fromObject

Parameters

Returns void

`Protected`getTypeString

Returns string

needsParenthesis

Returns boolean

stringify

Parameters

Returns string

toObject

Returns JSONOutput.LiteralType

toString

Returns string

visit

Type Parameters

Parameters

Returns T

Type Parameters

Parameters

Returns T | undefined

Properties

`Readonly`type

value

Settings

On This Page

Class LiteralType

Hierarchy (View Summary)

Index

Constructors

Methods

Properties

Constructors

constructor

Parameters

Returns Models.LiteralType

Methods

estimatePrintWidth

Returns number

fromObject

Parameters

Returns void

ProtectedgetTypeString

Returns string

needsParenthesis

Returns boolean

stringify

Parameters

Returns string

toObject

Returns JSONOutput.LiteralType

toString

Returns string

visit

Type Parameters

Parameters

Returns T

Type Parameters

Parameters

Returns T | undefined

Properties

Readonlytype

value

Settings

On This Page

`Protected`getTypeString

`Readonly`type