Interface JDocNode

Main jdoc.json node structure from TypeDoc

interface JDocNode {
    children?: JDocNode[];
    comment?: CommentNode;
    flags?: Record<string, boolean>;
    groups?: any[];
    id: number;
    kind: number;
    kindString?: string;
    name: string;
    parameters?: ParameterNode[];
    signatures?: SignatureNode[];
    sources?: SourceLocation[];
    type?: TypeNode;
    variant: string;
}

Index

Properties

children? comment? flags? groups? id kind kindString? name parameters? signatures? sources? type? variant

Properties

`Optional`children

children?: JDocNode[]

`Optional`comment

comment?: CommentNode

`Optional`flags

flags?: Record<string, boolean>

`Optional`groups

groups?: any[]

id

id: number

kind

kind: number

`Optional`kindString

kindString?: string

name

name: string

`Optional`parameters

parameters?: ParameterNode[]

`Optional`signatures

signatures?: SignatureNode[]

`Optional`sources

sources?: SourceLocation[]

`Optional`type

type?: TypeNode

variant

variant: string