@types/koa-docs

Installation

npm install --save @types/koa-docs

Summary

This package contains type definitions for koa-docs (https://github.com/a-s-o/koa-docs#readme).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/koa-docs.

index.d.ts

import { Middleware } from "koa";
import { Spec } from "koa-joi-router";

export {};

declare namespace koaDocs {
    interface Options {
        title?: string | undefined;
        version: string;
        routeHandlers?: string | undefined;
        theme?: string | undefined;
        groups: Array<{
            groupName: string;
            description?: string | undefined;
            extendedDescription?: string | undefined;
            prefix?: string | undefined;
            routes: Spec[];
        }>;
    }
}

export function get(path: string, options: koaDocs.Options): Middleware;

Additional Details

• Last updated: Tue, 07 Nov 2023 0938 GMT
• Dependencies: @types/koa, @types/koa-joi-router

Credits

These definitions were written by 4doge.