Class UnknownType

Represents all unknown types that cannot be converted by TypeDoc.

Hierarchy (View Summary)

Models.Type
- UnknownType

Index

Constructors

Methods

estimatePrintWidth fromObject getTypeString needsParenthesis stringify toObject toString visit

Properties

Constructors

constructor

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

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

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

`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:1469

needsParenthesis

needsParenthesis(context: Models.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: Models.TypeContext
Returns boolean
Overrides Type.needsParenthesis
- Defined in lib/models/types.ts:1477

stringify

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

toObject

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

toString

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

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

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:40
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:41

Properties

name

name: string

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

`Readonly`type

type: "unknown"

The type name identifier.