@types/apidoc

Installation

npm install --save @types/apidoc

Summary

This package contains type definitions for apidoc (https://github.com/apidoc/apidoc).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/apidoc.

index.d.ts

export interface ParsedFile {
    filename: string;
    extension: string;
    src: string;
    blocks: Array<{ global: any; local: any }>;
}

export interface DocOptions {
    excludeFilters?: string[] | undefined;
    includeFilters?: string[] | undefined;
    src?: string | undefined;
    dest?: string | undefined;
    template?: string | undefined;
    templateSingleFile?: string | undefined;
    config?: string | undefined;
    apiprivate?: boolean | undefined;
    verbose?: boolean | undefined;
    single?: boolean | undefined;
    debug?: boolean | undefined;
    colorize?: boolean | undefined;
    filters?: Record<string, string> | {
        [keys: string]: {
            postFilter: (parsedFiles: ParsedFile[], parsedFilenames: string[]) => void;
        };
    } | undefined;
    languages?: Record<string, string> | {
        [language: string]: {
            docBlocksRegExp: RegExp;
            inlineRegExp: RegExp;
        };
    } | undefined;
    parsers?: Record<string, string> | {
        parse: (content: string, source: string, messages: string) => {
            name: string;
            title: string;
            description: string;
        };
        path: string;
        getGroup?: (() => string) | undefined;
        markdownFields?: string[] | undefined;
        markdownRemovePTags?: string[] | undefined;
    } | undefined;
    workers?: Record<string, string> | {
        [keys: string]: any;
    } | undefined;
    silent?: boolean | undefined;
    dryRun?: boolean | undefined;
    markdown?: boolean | undefined;
    lineEnding?: string | undefined;
    encoding?: string | undefined;
    copyDefinitions?: boolean | undefined;
    filterBy?: string | string[] | undefined;
}

export function createDoc(
    options: DocOptions,
): boolean | { data: Array<Record<string, any>>; project: Record<string, any> };

Additional Details

• Last updated: Mon, 06 Nov 2023 22:41:04 GMT
• Dependencies: none

Credits

These definitions were written by rigwild, hoonga, and NicolasCARPi.