# @types/request-debug

> TypeScript definitions for request-debug

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

## Install

```sh
npm install @types/request-debug
pnpm add @types/request-debug
yarn add @types/request-debug
bun add @types/request-debug
```

## 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; pre 1.0.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 0.2.3 |
| Published | 2023-11-07 |
| First published | 2019-08-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 6.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51445 |
| Maintainers | types |

## Links

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

## Dependencies (1)

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

## Recent versions

- 0.2.3 (latest) — 2023-11-07
- 0.2.0 (ts2.3) — 2019-08-26
- 0.2.2 — 2023-10-18
- 0.2.1 — 2023-09-27

## README

# Installation
> `npm install --save @types/request-debug`

# Summary
This package contains type definitions for request-debug (https://github.com/request/request-debug).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/request-debug.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/request-debug/index.d.ts)
````ts
export = request_debug;

import { CoreOptions, Headers, Request, RequestAPI, RequiredUriUrl, UriOptions, UrlOptions } from "request";

declare namespace request_debug {
    type LogPhase = "request" | "response" | "redirect" | "auth";

    interface RequestData {
        debugId: number;
        method: string;
        uri: string;
        headers: Headers;
        body?: any;
    }

    interface ResponseData {
        debugId: number;
        headers: Headers;
        statusCode: number;
        body?: any;
    }

    interface RedirectData {
        debugId: number;
        headers: Headers;
        statusCode: number;
        uri: string;
    }
    type LogData = RequestData | ResponseData | RedirectData;

    interface LogCallback<
        TRequest extends Request,
        TOptions extends CoreOptions,
        TUriUrlOptions extends RequiredUriUrl,
    > {
        (type: "request", data: RequestData, r: RequestAPI<TRequest, TOptions, TUriUrlOptions>): void;
    }
    interface LogCallback<
        TRequest extends Request,
        TOptions extends CoreOptions,
        TUriUrlOptions extends RequiredUriUrl,
    > {
        (type: "response", data: ResponseData, r: RequestAPI<TRequest, TOptions, TUriUrlOptions>): void;
    }
    interface LogCallback<
        TRequest extends Request,
        TOptions extends CoreOptions,
        TUriUrlOptions extends RequiredUriUrl,
    > {
        (type: "redirect" | "auth", data: RedirectData, r: RequestAPI<TRequest, TOptions, TUriUrlOptions>): void;
    }
    interface LogCallback<
        TRequest extends Request,
        TOptions extends CoreOptions,
        TUriUrlOptions extends RequiredUriUrl,
    > {
        (type: LogPhase, data: LogData, r: RequestAPI<TRequest, TOptions, TUriUrlOptions>): void;
    }

    const log: LogCallback<Request, CoreOptions, RequiredUriUrl>;
}

declare function request_debug<
    TRequest extends Request,
    TOptions extends CoreOptions,
    TUriUrlOptions extends RequiredUriUrl,
>(
    request: RequestAPI<TRequest, TOptions, TUriUrlOptions>,
    cb?: request_debug.LogCallback<TRequest, TOptions, TUriUrlOptions>,
): void;

````

### Additional Details
 * Last updated: Tue, 07 Nov 2023 15:11:36 GMT
 * Dependencies: [@types/request](https://npmjs.com/package/@types/request)

# Credits
These definitions were written by [Marcello Urbani](https://github.com/marcellourbani).

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