@types/koa-docs v2.1.4

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

// Type definitions for koa-docs 2.1
// Project: https://github.com/a-s-o/koa-docs#readme
// Definitions by: 4doge <https://github.com/4doge>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
// TypeScript Version: 2.4

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: Thu, 08 Jul 2021 16:23:20 GMT
• Dependencies: @types/koa, @types/koa-joi-router
• Global values: none

Credits

These definitions were written by 4doge.