Class UnknownType

Represents all unknown types that cannot be converted by TypeDoc.

Hierarchy

Type
- UnknownType

Index

Constructors

Properties

Methods

getTypeString needsParenthesis stringify toObject toString visit

Constructors

constructor

new UnknownType(name: string): UnknownType
Parameters
- name: string
Returns UnknownType
Overrides Type.constructor
- Defined in src/lib/models/types.ts:1266

Properties

name

name: string

A string representation of the type as returned from TypeScript compiler.

`Readonly` type

type: "unknown" = "unknown"

The type name identifier.

Methods

`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 src/lib/models/types.ts:1271

needsParenthesis

needsParenthesis(context: TypeContext): boolean
Always returns true if not at the root level, we have no idea what's in here, so wrap it in parenthesis to be extra safe.
Parameters
- context: TypeContext
Returns boolean
Overrides Type.needsParenthesis
- Defined in src/lib/models/types.ts:1279

stringify

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

toObject

toObject(): JSONOutput.UnknownType
Returns JSONOutput.UnknownType
Overrides Type.toObject
- Defined in src/lib/models/types.ts:1283

toString

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

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

visit

visit<T>(visitor: TypeVisitor<T>): 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 src/lib/models/types.ts:28
visit<T>(visitor: Partial<TypeVisitor<T>>): undefined | T
Type Parameters
- T
Parameters
- visitor: Partial<TypeVisitor<T>>
Returns undefined | T
Inherited from Type.visit
- Defined in src/lib/models/types.ts:29

Generated using TypeDoc