Class LiteralType

Represents a literal type.

type A = "A"
type B = 1

Hierarchy (view full)

Models.Type
- LiteralType

Index

Constructors

constructor

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

Properties

`Readonly`type

type = "literal"

The type name identifier.

value

Methods

fromObject

fromObject(_de, _obj): void
Parameters
- _de: Deserializer
- _obj: JSONOutput.SomeType
Returns void
Inherited from Type.fromObject
- Defined in models/types.ts:50

`Protected`getTypeString

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

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

needsParenthesis

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

stringify

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

toObject

toObject(): JSONOutput.LiteralType
Returns JSONOutput.LiteralType
Overrides Type.toObject
- Defined in models/types.ts:550

toString

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

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

visit

visit<T>(visitor): T
Visit this type, returning the value returned by the visitor.
Type Parameters
- T
Parameters
- visitor: TypeVisitor<T>
Returns T
Inherited from Type.visit
- Defined in models/types.ts:34
visit<T>(visitor): undefined | T
Type Parameters
- T
Parameters
- visitor: Partial<TypeVisitor<T>>
Returns undefined | T
Inherited from Type.visit
- Defined in models/types.ts:35

Class LiteralType

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Models.LiteralType

Properties

`Readonly`type

value

Methods

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 undefined | T

Settings

On This Page

Class LiteralType

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Models.LiteralType

Properties

Readonlytype

value

Methods

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 undefined | T

Settings

On This Page

`Readonly`type

`Protected`getTypeString