Interface: ApiDocItem

Properties

id

id: string

name

name: string

kind

kind: ApiDocKind

description

optional

description: string

signature

optional

signature: string

parameters

optional

parameters: ApiDocParameter[]

returns

optional

returns: ApiDocReturn

examples

optional

examples: string[]

tags

optional

tags: ApiDocTag[]

children

optional

children: ApiDocItem[]

source

optional

source: ApiDocSource

typeParameters

optional

typeParameters: ApiDocTypeParameter[]

hierarchy

optional

hierarchy: ApiDocHierarchy

Source

typedoc/types.ts

← ApiDocHierarchy | ApiDocParameter →