Class UnknownType

Represents all unknown types that cannot be converted by TypeDoc.

Hierarchy (view full)

Models.Type
- UnknownType

Index

Constructors

Properties

Methods

fromObject getTypeString needsParenthesis stringify toObject toString visit

Constructors

constructor

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

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

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
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 models/types.ts:1403

needsParenthesis

needsParenthesis(context): 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 models/types.ts:1411

stringify

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

toObject

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

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