type2docfx/src/interfaces/YamlModel.ts

A tool to convert json format output from TypeDoc to universal reference model for DocFx to consume.

export interface YamlModel {
    uid: string;
    name: string;
    children: Array<YamlModel> | Array<string>;
    langs: Array<string>;
    type: string;
    summary?: string;
    syntax?: Syntax;
    fullName?: string;
    exceptions?: Array<Exception>;
    numericValue?: number;
    package?: string;
    module?: string;
    source?: Source;
    extends?: NameWithUrl;
    deprecated?: Deprecated;
    isPreview?: boolean;
    remarks?: string;
    optional?: boolean;
}

export type Types = Type[] | string[];

interface NameWithUrl {
    name: Type | string;
    href?: string;
}
interface Deprecated {
    content: string;
}

interface Source {
    path: string;
    startLine: number;
    remote: Remote;
}

interface Remote {
    path: string;
    branch: string;
    repo: string;
}

export interface Reference {
    uid?: string;
    name?: string;
    fullName?: string;
    'spec.typeScript'?: Reference[];
}

export interface Syntax {
    parameters?: Array<YamlParameter>;
    content?: string;
    return?: Return;
}

interface Return {
    type: Types;
}

export interface YamlParameter {
    id: string;
    type: Types;
    description: string;
    optional?: boolean;
}

export interface Root {
    items: Array<YamlModel>;
    references?: Array<Reference>;
}

export interface Type {
    typeName?: string;
    typeId?: number;
    reflectedType?: ReflectedType;
    genericType?: GenericType;
    intersectionType?: IntersectionType;
    unionType?: UnionType;
    arrayType?: Type | string;
}

export interface UnionType {
    types: Type[] | string[];
}

export interface IntersectionType {
    types: Type[] | string[];
}

export interface GenericType {
    outter: Type | string;
    inner: Type[] | string[];
}

export interface ReflectedType {
    key: Type | string;
    value: Type | string;
}

export interface Exception {
    type: string;
    description: string;
}