@types/express-ws/README.md

TypeScript definitions for express-ws

# Installation
> `npm install --save @types/express-ws`

# Summary
This package contains type definitions for express-ws (https://github.com/HenningM/express-ws).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/express-ws.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/express-ws/index.d.ts)
````ts
import * as express from "express";
import * as core from "express-serve-static-core";
import * as http from "http";
import * as https from "https";
import * as ws from "ws";

declare module "express" {
    function Router(options?: RouterOptions): expressWs.Router;
}

declare function expressWs(
    app: express.Application,
    server?: http.Server | https.Server,
    options?: expressWs.Options,
): expressWs.Instance;
declare namespace expressWs {
    type Application = express.Application & WithWebsocketMethod;
    type Router = express.Router & WithWebsocketMethod;

    interface Options {
        leaveRouterUntouched?: boolean | undefined;
        wsOptions?: ws.ServerOptions | undefined;
    }

    interface RouterLike {
        get: express.IRouterMatcher<this>;
        [key: string]: any;
        [key: number]: any;
    }

    interface Instance {
        app: Application;
        applyTo(target: RouterLike): void;
        getWss(): ws.Server;
    }

    type WebsocketRequestHandler = (ws: ws.WebSocket, req: express.Request, next: express.NextFunction) => void;
    type WebsocketMethod<T> = (route: core.PathParams, ...middlewares: WebsocketRequestHandler[]) => T;

    interface WithWebsocketMethod {
        ws: WebsocketMethod<this>;
    }
}

export = expressWs;

````

### Additional Details
 * Last updated: Tue, 27 Aug 2024 06:10:02 GMT
 * Dependencies: [@types/express](https://npmjs.com/package/@types/express), [@types/express-serve-static-core](https://npmjs.com/package/@types/express-serve-static-core), [@types/ws](https://npmjs.com/package/@types/ws)

# Credits
These definitions were written by [AJ Livingston](https://github.com/ajliv).