# @types/koa-docs

> TypeScript definitions for koa-docs

Latest version **2.1.4** (published 2023-11-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install @types/koa-docs
pnpm add @types/koa-docs
yarn add @types/koa-docs
bun add @types/koa-docs
```

## Health

**Score 45/100 (D)** — status: abandoned.

Positive: has types; no vulnerabilities; high maintenance score; popular repo; extremely popular.

Warnings: low downloads; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 2.1.4 |
| Published | 2023-11-07 |
| First published | 2019-11-04 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 3.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51445 |
| Maintainers | types |

## Links

- npm: https://www.npmjs.com/package/@types/koa-docs
- Repository: https://github.com/DefinitelyTyped/DefinitelyTyped
- Homepage: https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/koa-docs
- npm.io page: https://npm.io/package/@types/koa-docs

## Dependencies (2)

- [@types/koa](https://npm.io/package/@types/koa.md) *
- [@types/koa-joi-router](https://npm.io/package/@types/koa-joi-router.md) *

## Recent versions

- 2.1.4 (latest) — 2023-11-07
- 2.1.1 (ts3.6) — 2021-07-08
- 2.1.0 (ts2.4) — 2019-11-04
- 2.1.3 — 2023-10-18
- 2.1.2 — 2023-09-14

## README

# 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](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/koa-docs/index.d.ts)
````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 09:09:38 GMT
 * Dependencies: [@types/koa](https://npmjs.com/package/@types/koa), [@types/koa-joi-router](https://npmjs.com/package/@types/koa-joi-router)

# Credits
These definitions were written by [4doge](https://github.com/4doge).

---
_Source: https://npm.io/package/@types/koa-docs · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._