mirror of
https://github.com/gosticks/DefinitelyTyped.git
synced 2026-02-10 19:02:48 +00:00
17673008d4
* Add test, too * proxyReqPathResolver: can also return promise proxyReqPathResolver can also return a promise to a string * Update version number Update version number of express-http-proxy to 1.6
65 lines
2.4 KiB
TypeScript
65 lines
2.4 KiB
TypeScript
// Type definitions for express-http-proxy 1.6
|
|
// Project: https://github.com/villadora/express-http-proxy#readme
|
|
// Definitions by: ulrichb <https://github.com/ulrichb>
|
|
// Daniel Schopf <https://github.com/Danscho>
|
|
// Gabriel Fournier <https://github.com/carboneater>
|
|
// Niek van Bennekom <https://github.com/niekvb>
|
|
// John L. Singleton <https://github.com/jsinglet>
|
|
// Lindsay Wardell <https://github.com/lindsaykwardell>
|
|
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
|
|
// TypeScript Version: 2.3
|
|
|
|
import { RequestHandler, Request, Response, NextFunction } from "express";
|
|
import { RequestOptions, IncomingHttpHeaders, OutgoingHttpHeaders } from "http";
|
|
|
|
declare namespace proxy {
|
|
interface ProxyOptions {
|
|
/**
|
|
* The byte limit of the body. This is the number of bytes or any string
|
|
* format supported by `bytes`, for example `1000`, `'500kb'` or `'3mb'`.
|
|
* See https://github.com/stream-utils/raw-body/blob/master/index.d.ts
|
|
*/
|
|
limit?: number | string;
|
|
proxyErrorHandler?: (
|
|
err: any,
|
|
res: Response,
|
|
next: NextFunction
|
|
) => any;
|
|
proxyReqPathResolver?: (req: Request) => string | Promise<string>;
|
|
proxyReqOptDecorator?: (
|
|
proxyReqOpts: RequestOptions,
|
|
srcReq: Request
|
|
) => RequestOptions | Promise<RequestOptions>;
|
|
userResHeaderDecorator?: (
|
|
headers: IncomingHttpHeaders,
|
|
userReq: Request,
|
|
userRes: Response,
|
|
proxyReq: Request,
|
|
proxyRes: Response
|
|
) => OutgoingHttpHeaders;
|
|
userResDecorator?: (
|
|
proxyRes: Response,
|
|
proxyResData: any,
|
|
userReq: Request,
|
|
userRes: Response
|
|
) => Buffer | string | Promise<Buffer | string>;
|
|
filter?: (req: Request, res: Response) => boolean;
|
|
skipToNextHandlerFilter?: (proxyRes: Response) => boolean;
|
|
proxyReqBodyDecorator?: (bodyContent: any, srcReq: Request) => any;
|
|
preserveHostHdr?: boolean;
|
|
parseReqBody?: boolean;
|
|
memoizeHost?: boolean;
|
|
https?: boolean;
|
|
reqAsBuffer?: boolean;
|
|
reqBodyEncoding?: string | null;
|
|
timeout?: number;
|
|
}
|
|
}
|
|
|
|
declare function proxy(
|
|
host: string | ((req: Request) => string),
|
|
options?: proxy.ProxyOptions
|
|
): RequestHandler;
|
|
|
|
export = proxy;
|