@types/mitm

Installation

npm install --save @types/mitm

Summary

This package contains type definitions for mitm (https://github.com/moll/node-mitm).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/mitm.

index.d.ts

/// <reference types="node"/>

declare module "mitm" {
    import * as http from "http";
    import * as net from "net";

    function mitm(): mitm.Mitm;

    namespace mitm {
        interface SocketOptions {
            port: number;
            host?: string | undefined;
            localAddress?: string | undefined;
            localPort?: string | undefined;
            family?: number | undefined;
            allowHalfOpen?: boolean | undefined;
        }

        interface BypassableSocket extends net.Socket {
            bypass(): void;
        }

        type SocketConnectCallback = (socket: BypassableSocket, opts: SocketOptions) => void;

        type SocketConnectionCallback = (socket: net.Socket, opts: SocketOptions) => void;

        type HttpCallback = (request: http.IncomingMessage, response: http.ServerResponse) => void;

        type Event = "connect" | "connection" | "request";

        type Callback = SocketConnectCallback | SocketConnectionCallback | HttpCallback;

        interface Mitm {
            disable(): void;
            on(event: Event, callback: Callback): void;
            on(event: "connect", callback: SocketConnectCallback): void;
            on(event: "connection", callback: SocketConnectionCallback): void;
            on(event: "request", callback: HttpCallback): void;
        }
    }

    export = mitm;
}

Additional Details

• Last updated: Thu, 23 Nov 2023 23:35:40 GMT
• Dependencies: @types/node

Credits

These definitions were written by Alejandro Sánchez.