FilesExpand file tree

master

/

types.ts

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

191 lines (181 loc) · 6.03 KB

master

/

types.ts

Copy path

Top

File metadata and controls

• Code
• Blame

191 lines (181 loc) · 6.03 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

81

82

83

84

85

86

87

88

89

90

91

92

93

94

95

96

97

98

99

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

/**

* Based on definition by DefinitelyTyped:

* https://github.com/DefinitelyTyped/DefinitelyTyped/blob/6f529c6c67a447190f86bfbf894d1061e41e07b7/types/http-proxy-middleware/index.d.ts

*/

import type * as http from 'node:http';

import type * as net from 'node:net';

import type { ProxyServer, ProxyServerOptions, ProxyTarget } from 'httpxy';

export type NextFunction<T = (err?: unknown) => void> = T;

export interface RequestHandler<

TReq extends http.IncomingMessage = http.IncomingMessage,

TRes extends http.ServerResponse = http.ServerResponse,

TNext = NextFunction,

> {

(req: TReq, res: TRes, next?: TNext): Promise<void>;

upgrade: (req: TReq, socket: net.Socket, head: Buffer) => void;

}

export type Filter<TReq extends http.IncomingMessage = http.IncomingMessage> =

| string

| string[]

| ((pathname: string, req: TReq) => boolean | string | RegExpMatchArray | null);

/**

* @see {@link https://github.com/chimurai/http-proxy-middleware/tree/master#defineplugin-helper `definePlugin()`} to define a http-proxy-middleware plugin.

*/

export interface Plugin<

TReq extends http.IncomingMessage = http.IncomingMessage,

TRes extends http.ServerResponse = http.ServerResponse,

> {

(proxyServer: ProxyServer<TReq, TRes>, options: Options<TReq, TRes>): void;

}

export interface OnProxyEvent<

TReq extends http.IncomingMessage = http.IncomingMessage,

TRes extends http.ServerResponse = http.ServerResponse,

> {

error?: (err: Error, req: TReq, res: TRes | net.Socket, target?: ProxyTarget) => void;

proxyReq?: (

proxyReq: http.ClientRequest,

req: TReq,

res: TRes,

options: ProxyServerOptions,

) => void;

proxyReqWs?: (

proxyReq: http.ClientRequest,

req: TReq,

socket: net.Socket,

options: ProxyServerOptions,

head: Buffer,

) => void;

proxyRes?: (proxyRes: TReq, req: TReq, res: TRes) => void | Promise<void>;

open?: (proxySocket: net.Socket) => void;

close?: (proxyRes: TReq, proxySocket: net.Socket, proxyHead: Buffer) => void;

start?: (req: TReq, res: TRes, target: ProxyTarget) => void;

end?: (req: TReq, res: TRes, proxyRes: TReq) => void;

econnreset?: (err: Error, req: TReq, res: TRes, target: ProxyTarget) => void;

}

export type Logger = Pick<Console, 'info' | 'warn' | 'error'>;

export type PathRewriteConfig<

TReq extends http.IncomingMessage = http.IncomingMessage,

TRes extends http.ServerResponse = http.ServerResponse,

> =

| { [regexp: string]: string }

| ((

path: string,

req: TReq,

/** `res` is undefined in WebSocket upgrade flows. */

res?: TRes | undefined,

options?: Options<TReq, TRes>,

) => string | undefined)

| ((

path: string,

req: TReq,

/** `res` is undefined in WebSocket upgrade flows. */

res?: TRes | undefined,

options?: Options<TReq, TRes>,

) => Promise<string | undefined>);

export interface Options<

TReq extends http.IncomingMessage = http.IncomingMessage,

TRes extends http.ServerResponse = http.ServerResponse,

> extends ProxyServerOptions {

/**

* Narrow down requests to proxy or not.

* Filter on {@link http.IncomingMessage.url `pathname`} which is relative to the proxy's "mounting" point in the server.

* Or use the {@link http.IncomingMessage `req`} object for more complex filtering.

* @link https://github.com/chimurai/http-proxy-middleware/blob/master/recipes/pathFilter.md

* @since v3.0.0

*/

pathFilter?: Filter<TReq>;

/**

* Modify request paths before requests are send to the target.

* @example

* ```js

* createProxyMiddleware({

* pathRewrite: {

* '^/api/old-path': '/api/new-path', // rewrite path

* }

* });

* ```

* @since v0.15.0

* @since v0.21.0 - support `async` function

* @since v4.1.0 - `res` and `options` parameters added to custom function

*

* @link https://github.com/chimurai/http-proxy-middleware/blob/master/recipes/pathRewrite.md

*/

pathRewrite?: PathRewriteConfig<TReq, TRes>;

/**

* Access the internal `httpxy` server instance to customize behavior

*

* @example

* ```js

* createProxyMiddleware({

* plugins: [(proxyServer, options) => {

* proxyServer.on('error', (error, req, res) => {

* console.error(error);

* });

* }]

* });

* ```

* @link https://github.com/chimurai/http-proxy-middleware#plugins-array

* @since v3.0.0

*/

plugins?: Plugin<TReq, TRes>[];

/**

* Eject pre-configured plugins.

* NOTE: register your own error handlers to prevent server from crashing.

*

* @link https://github.com/chimurai/http-proxy-middleware#ejectplugins-boolean-default-false

* @since v3.0.0

*/

ejectPlugins?: boolean;

/**

* Listen to `httpxy` events

* @see {@link OnProxyEvent} for available events

* @example

* ```js

* createProxyMiddleware({

* on: {

* error: (error, req, res, target) => {

* console.error(error);

* }

* }

* });

* ```

* @link https://github.com/chimurai/http-proxy-middleware/blob/master/recipes/proxy-events.md

* @since v3.0.0

*/

on?: OnProxyEvent<TReq, TRes>;

/**

* Dynamically set the {@link Options.target `options.target`}.

*

* @example

* ```js

* createProxyMiddleware({

* router: async (req, res, options) => {

* return 'http://127:0.0.1:3000';

* }

* });

* ```

*

* @since v0.16.0

* @since v4.1.0 - `res` and `options` parameters added to router function signature

*

* NOTE: `res` is undefined in WebSocket upgrade flows.

*

* @link https://github.com/chimurai/http-proxy-middleware/blob/master/recipes/router.md

*/

router?:

| Record<string, ProxyTarget>

| ((req: TReq, res: TRes | undefined, options: Options<TReq, TRes>) => ProxyTarget)

| ((req: TReq, res: TRes | undefined, options: Options<TReq, TRes>) => Promise<ProxyTarget>);

/**

* Log information from http-proxy-middleware

* @example

* ```js

* createProxyMiddleware({

* logger: console

* });

* ```

* @link https://github.com/chimurai/http-proxy-middleware/blob/master/recipes/logger.md

* @since v3.0.0

*/

logger?: Logger;

}