# @types/koa-bunyan-logger

> TypeScript definitions for koa-bunyan-logger

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

## Install

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

## 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.7 |
| Published | 2023-11-07 |
| First published | 2018-09-04 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 6.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51432 |
| Maintainers | types |

## Links

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

## Dependencies (2)

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

## Recent versions

- 2.1.7 (latest) — 2023-11-07
- 2.1.4 (ts3.6) — 2021-07-08
- 2.1.3 (ts3.2) — 2020-10-28
- 2.1.2 (ts2.8) — 2020-01-30
- 2.1.1 (ts2.3) — 2019-05-13
- 2.1.6 — 2023-10-18
- 2.1.5 — 2023-09-14
- 2.1.0 — 2019-02-04
- 2.0.0 — 2018-09-04

## README

# Installation
> `npm install --save @types/koa-bunyan-logger`

# Summary
This package contains type definitions for koa-bunyan-logger (https://github.com/koajs/bunyan-logger).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/koa-bunyan-logger.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/koa-bunyan-logger/index.d.ts)
````ts
import { Middleware, Request, Response } from "koa";

import Logger = require("bunyan");

declare function koaBunyanLogger(logger?: Logger): Middleware;

declare namespace koaBunyanLogger {
    interface RequestData {
        req: Request;
    }

    interface ResponseData {
        req: Request;
        res: Response;
    }

    interface RequestIdContextOptions {
        header?: string | undefined;
        prop?: string | undefined;
        requestProp?: string | undefined;
        field?: string | undefined;
    }

    interface RequestLoggerOptions {
        durationField?: string | undefined;
        levelFn?: ((status: number, err: Error) => string) | undefined;
        updateLogFields?: ((data: RequestData) => RequestData) | undefined;
        updateRequestLogFields?: ((requestData: RequestData) => RequestData) | undefined;
        updateResponseLogFields?: ((responseData: ResponseData) => ResponseData) | undefined;
        formatRequestMessage?: ((requestData: RequestData) => string) | undefined;
        formatResponseMessage?: ((responseData: ResponseData) => string) | undefined;
        ignorePath?: string[] | undefined;
    }

    interface TimeContextOptions {
        logLevel?: string | undefined;
        updateLogFields?: ((fields: any) => any) | undefined;
    }

    function requestLogger(opts?: RequestLoggerOptions): Middleware;
    function requestIdContext(opts?: RequestIdContextOptions): Middleware;
    function timeContext(opts?: TimeContextOptions): Middleware;
}

// Extend the Koa context to add the logger..
declare module "koa" {
    interface BaseContext {
        log: Logger;
    }
}

export = koaBunyanLogger;

````

### Additional Details
 * Last updated: Tue, 07 Nov 2023 09:09:38 GMT
 * Dependencies: [@types/bunyan](https://npmjs.com/package/@types/bunyan), [@types/koa](https://npmjs.com/package/@types/koa)

# Credits
These definitions were written by [Steven McDowall](https://github.com/sjmcdowall), and [Jan Karlo Dela Cruz](https://github.com/jankdc).

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