1 | declare module 'http2' {
|
---|
2 | import EventEmitter = require('events');
|
---|
3 | import * as fs from 'fs';
|
---|
4 | import * as net from 'net';
|
---|
5 | import * as stream from 'stream';
|
---|
6 | import * as tls from 'tls';
|
---|
7 | import * as url from 'url';
|
---|
8 |
|
---|
9 | import {
|
---|
10 | IncomingHttpHeaders as Http1IncomingHttpHeaders,
|
---|
11 | OutgoingHttpHeaders,
|
---|
12 | IncomingMessage,
|
---|
13 | ServerResponse,
|
---|
14 | } from 'http';
|
---|
15 | export { OutgoingHttpHeaders } from 'http';
|
---|
16 |
|
---|
17 | export interface IncomingHttpStatusHeader {
|
---|
18 | ":status"?: number | undefined;
|
---|
19 | }
|
---|
20 |
|
---|
21 | export interface IncomingHttpHeaders extends Http1IncomingHttpHeaders {
|
---|
22 | ":path"?: string | undefined;
|
---|
23 | ":method"?: string | undefined;
|
---|
24 | ":authority"?: string | undefined;
|
---|
25 | ":scheme"?: string | undefined;
|
---|
26 | }
|
---|
27 |
|
---|
28 | // Http2Stream
|
---|
29 |
|
---|
30 | export interface StreamPriorityOptions {
|
---|
31 | exclusive?: boolean | undefined;
|
---|
32 | parent?: number | undefined;
|
---|
33 | weight?: number | undefined;
|
---|
34 | silent?: boolean | undefined;
|
---|
35 | }
|
---|
36 |
|
---|
37 | export interface StreamState {
|
---|
38 | localWindowSize?: number | undefined;
|
---|
39 | state?: number | undefined;
|
---|
40 | localClose?: number | undefined;
|
---|
41 | remoteClose?: number | undefined;
|
---|
42 | sumDependencyWeight?: number | undefined;
|
---|
43 | weight?: number | undefined;
|
---|
44 | }
|
---|
45 |
|
---|
46 | export interface ServerStreamResponseOptions {
|
---|
47 | endStream?: boolean | undefined;
|
---|
48 | waitForTrailers?: boolean | undefined;
|
---|
49 | }
|
---|
50 |
|
---|
51 | export interface StatOptions {
|
---|
52 | offset: number;
|
---|
53 | length: number;
|
---|
54 | }
|
---|
55 |
|
---|
56 | export interface ServerStreamFileResponseOptions {
|
---|
57 | statCheck?(stats: fs.Stats, headers: OutgoingHttpHeaders, statOptions: StatOptions): void | boolean;
|
---|
58 | waitForTrailers?: boolean | undefined;
|
---|
59 | offset?: number | undefined;
|
---|
60 | length?: number | undefined;
|
---|
61 | }
|
---|
62 |
|
---|
63 | export interface ServerStreamFileResponseOptionsWithError extends ServerStreamFileResponseOptions {
|
---|
64 | onError?(err: NodeJS.ErrnoException): void;
|
---|
65 | }
|
---|
66 |
|
---|
67 | export interface Http2Stream extends stream.Duplex {
|
---|
68 | readonly aborted: boolean;
|
---|
69 | readonly bufferSize: number;
|
---|
70 | readonly closed: boolean;
|
---|
71 | readonly destroyed: boolean;
|
---|
72 | /**
|
---|
73 | * Set the true if the END_STREAM flag was set in the request or response HEADERS frame received,
|
---|
74 | * indicating that no additional data should be received and the readable side of the Http2Stream will be closed.
|
---|
75 | */
|
---|
76 | readonly endAfterHeaders: boolean;
|
---|
77 | readonly id?: number | undefined;
|
---|
78 | readonly pending: boolean;
|
---|
79 | readonly rstCode: number;
|
---|
80 | readonly sentHeaders: OutgoingHttpHeaders;
|
---|
81 | readonly sentInfoHeaders?: OutgoingHttpHeaders[] | undefined;
|
---|
82 | readonly sentTrailers?: OutgoingHttpHeaders | undefined;
|
---|
83 | readonly session: Http2Session;
|
---|
84 | readonly state: StreamState;
|
---|
85 |
|
---|
86 | close(code?: number, callback?: () => void): void;
|
---|
87 | priority(options: StreamPriorityOptions): void;
|
---|
88 | setTimeout(msecs: number, callback?: () => void): void;
|
---|
89 | sendTrailers(headers: OutgoingHttpHeaders): void;
|
---|
90 |
|
---|
91 | addListener(event: "aborted", listener: () => void): this;
|
---|
92 | addListener(event: "close", listener: () => void): this;
|
---|
93 | addListener(event: "data", listener: (chunk: Buffer | string) => void): this;
|
---|
94 | addListener(event: "drain", listener: () => void): this;
|
---|
95 | addListener(event: "end", listener: () => void): this;
|
---|
96 | addListener(event: "error", listener: (err: Error) => void): this;
|
---|
97 | addListener(event: "finish", listener: () => void): this;
|
---|
98 | addListener(event: "frameError", listener: (frameType: number, errorCode: number) => void): this;
|
---|
99 | addListener(event: "pipe", listener: (src: stream.Readable) => void): this;
|
---|
100 | addListener(event: "unpipe", listener: (src: stream.Readable) => void): this;
|
---|
101 | addListener(event: "streamClosed", listener: (code: number) => void): this;
|
---|
102 | addListener(event: "timeout", listener: () => void): this;
|
---|
103 | addListener(event: "trailers", listener: (trailers: IncomingHttpHeaders, flags: number) => void): this;
|
---|
104 | addListener(event: "wantTrailers", listener: () => void): this;
|
---|
105 | addListener(event: string | symbol, listener: (...args: any[]) => void): this;
|
---|
106 |
|
---|
107 | emit(event: "aborted"): boolean;
|
---|
108 | emit(event: "close"): boolean;
|
---|
109 | emit(event: "data", chunk: Buffer | string): boolean;
|
---|
110 | emit(event: "drain"): boolean;
|
---|
111 | emit(event: "end"): boolean;
|
---|
112 | emit(event: "error", err: Error): boolean;
|
---|
113 | emit(event: "finish"): boolean;
|
---|
114 | emit(event: "frameError", frameType: number, errorCode: number): boolean;
|
---|
115 | emit(event: "pipe", src: stream.Readable): boolean;
|
---|
116 | emit(event: "unpipe", src: stream.Readable): boolean;
|
---|
117 | emit(event: "streamClosed", code: number): boolean;
|
---|
118 | emit(event: "timeout"): boolean;
|
---|
119 | emit(event: "trailers", trailers: IncomingHttpHeaders, flags: number): boolean;
|
---|
120 | emit(event: "wantTrailers"): boolean;
|
---|
121 | emit(event: string | symbol, ...args: any[]): boolean;
|
---|
122 |
|
---|
123 | on(event: "aborted", listener: () => void): this;
|
---|
124 | on(event: "close", listener: () => void): this;
|
---|
125 | on(event: "data", listener: (chunk: Buffer | string) => void): this;
|
---|
126 | on(event: "drain", listener: () => void): this;
|
---|
127 | on(event: "end", listener: () => void): this;
|
---|
128 | on(event: "error", listener: (err: Error) => void): this;
|
---|
129 | on(event: "finish", listener: () => void): this;
|
---|
130 | on(event: "frameError", listener: (frameType: number, errorCode: number) => void): this;
|
---|
131 | on(event: "pipe", listener: (src: stream.Readable) => void): this;
|
---|
132 | on(event: "unpipe", listener: (src: stream.Readable) => void): this;
|
---|
133 | on(event: "streamClosed", listener: (code: number) => void): this;
|
---|
134 | on(event: "timeout", listener: () => void): this;
|
---|
135 | on(event: "trailers", listener: (trailers: IncomingHttpHeaders, flags: number) => void): this;
|
---|
136 | on(event: "wantTrailers", listener: () => void): this;
|
---|
137 | on(event: string | symbol, listener: (...args: any[]) => void): this;
|
---|
138 |
|
---|
139 | once(event: "aborted", listener: () => void): this;
|
---|
140 | once(event: "close", listener: () => void): this;
|
---|
141 | once(event: "data", listener: (chunk: Buffer | string) => void): this;
|
---|
142 | once(event: "drain", listener: () => void): this;
|
---|
143 | once(event: "end", listener: () => void): this;
|
---|
144 | once(event: "error", listener: (err: Error) => void): this;
|
---|
145 | once(event: "finish", listener: () => void): this;
|
---|
146 | once(event: "frameError", listener: (frameType: number, errorCode: number) => void): this;
|
---|
147 | once(event: "pipe", listener: (src: stream.Readable) => void): this;
|
---|
148 | once(event: "unpipe", listener: (src: stream.Readable) => void): this;
|
---|
149 | once(event: "streamClosed", listener: (code: number) => void): this;
|
---|
150 | once(event: "timeout", listener: () => void): this;
|
---|
151 | once(event: "trailers", listener: (trailers: IncomingHttpHeaders, flags: number) => void): this;
|
---|
152 | once(event: "wantTrailers", listener: () => void): this;
|
---|
153 | once(event: string | symbol, listener: (...args: any[]) => void): this;
|
---|
154 |
|
---|
155 | prependListener(event: "aborted", listener: () => void): this;
|
---|
156 | prependListener(event: "close", listener: () => void): this;
|
---|
157 | prependListener(event: "data", listener: (chunk: Buffer | string) => void): this;
|
---|
158 | prependListener(event: "drain", listener: () => void): this;
|
---|
159 | prependListener(event: "end", listener: () => void): this;
|
---|
160 | prependListener(event: "error", listener: (err: Error) => void): this;
|
---|
161 | prependListener(event: "finish", listener: () => void): this;
|
---|
162 | prependListener(event: "frameError", listener: (frameType: number, errorCode: number) => void): this;
|
---|
163 | prependListener(event: "pipe", listener: (src: stream.Readable) => void): this;
|
---|
164 | prependListener(event: "unpipe", listener: (src: stream.Readable) => void): this;
|
---|
165 | prependListener(event: "streamClosed", listener: (code: number) => void): this;
|
---|
166 | prependListener(event: "timeout", listener: () => void): this;
|
---|
167 | prependListener(event: "trailers", listener: (trailers: IncomingHttpHeaders, flags: number) => void): this;
|
---|
168 | prependListener(event: "wantTrailers", listener: () => void): this;
|
---|
169 | prependListener(event: string | symbol, listener: (...args: any[]) => void): this;
|
---|
170 |
|
---|
171 | prependOnceListener(event: "aborted", listener: () => void): this;
|
---|
172 | prependOnceListener(event: "close", listener: () => void): this;
|
---|
173 | prependOnceListener(event: "data", listener: (chunk: Buffer | string) => void): this;
|
---|
174 | prependOnceListener(event: "drain", listener: () => void): this;
|
---|
175 | prependOnceListener(event: "end", listener: () => void): this;
|
---|
176 | prependOnceListener(event: "error", listener: (err: Error) => void): this;
|
---|
177 | prependOnceListener(event: "finish", listener: () => void): this;
|
---|
178 | prependOnceListener(event: "frameError", listener: (frameType: number, errorCode: number) => void): this;
|
---|
179 | prependOnceListener(event: "pipe", listener: (src: stream.Readable) => void): this;
|
---|
180 | prependOnceListener(event: "unpipe", listener: (src: stream.Readable) => void): this;
|
---|
181 | prependOnceListener(event: "streamClosed", listener: (code: number) => void): this;
|
---|
182 | prependOnceListener(event: "timeout", listener: () => void): this;
|
---|
183 | prependOnceListener(event: "trailers", listener: (trailers: IncomingHttpHeaders, flags: number) => void): this;
|
---|
184 | prependOnceListener(event: "wantTrailers", listener: () => void): this;
|
---|
185 | prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): this;
|
---|
186 | }
|
---|
187 |
|
---|
188 | export interface ClientHttp2Stream extends Http2Stream {
|
---|
189 | addListener(event: "continue", listener: () => {}): this;
|
---|
190 | addListener(event: "headers", listener: (headers: IncomingHttpHeaders & IncomingHttpStatusHeader, flags: number) => void): this;
|
---|
191 | addListener(event: "push", listener: (headers: IncomingHttpHeaders, flags: number) => void): this;
|
---|
192 | addListener(event: "response", listener: (headers: IncomingHttpHeaders & IncomingHttpStatusHeader, flags: number) => void): this;
|
---|
193 | addListener(event: string | symbol, listener: (...args: any[]) => void): this;
|
---|
194 |
|
---|
195 | emit(event: "continue"): boolean;
|
---|
196 | emit(event: "headers", headers: IncomingHttpHeaders & IncomingHttpStatusHeader, flags: number): boolean;
|
---|
197 | emit(event: "push", headers: IncomingHttpHeaders, flags: number): boolean;
|
---|
198 | emit(event: "response", headers: IncomingHttpHeaders & IncomingHttpStatusHeader, flags: number): boolean;
|
---|
199 | emit(event: string | symbol, ...args: any[]): boolean;
|
---|
200 |
|
---|
201 | on(event: "continue", listener: () => {}): this;
|
---|
202 | on(event: "headers", listener: (headers: IncomingHttpHeaders & IncomingHttpStatusHeader, flags: number) => void): this;
|
---|
203 | on(event: "push", listener: (headers: IncomingHttpHeaders, flags: number) => void): this;
|
---|
204 | on(event: "response", listener: (headers: IncomingHttpHeaders & IncomingHttpStatusHeader, flags: number) => void): this;
|
---|
205 | on(event: string | symbol, listener: (...args: any[]) => void): this;
|
---|
206 |
|
---|
207 | once(event: "continue", listener: () => {}): this;
|
---|
208 | once(event: "headers", listener: (headers: IncomingHttpHeaders & IncomingHttpStatusHeader, flags: number) => void): this;
|
---|
209 | once(event: "push", listener: (headers: IncomingHttpHeaders, flags: number) => void): this;
|
---|
210 | once(event: "response", listener: (headers: IncomingHttpHeaders & IncomingHttpStatusHeader, flags: number) => void): this;
|
---|
211 | once(event: string | symbol, listener: (...args: any[]) => void): this;
|
---|
212 |
|
---|
213 | prependListener(event: "continue", listener: () => {}): this;
|
---|
214 | prependListener(event: "headers", listener: (headers: IncomingHttpHeaders & IncomingHttpStatusHeader, flags: number) => void): this;
|
---|
215 | prependListener(event: "push", listener: (headers: IncomingHttpHeaders, flags: number) => void): this;
|
---|
216 | prependListener(event: "response", listener: (headers: IncomingHttpHeaders & IncomingHttpStatusHeader, flags: number) => void): this;
|
---|
217 | prependListener(event: string | symbol, listener: (...args: any[]) => void): this;
|
---|
218 |
|
---|
219 | prependOnceListener(event: "continue", listener: () => {}): this;
|
---|
220 | prependOnceListener(event: "headers", listener: (headers: IncomingHttpHeaders & IncomingHttpStatusHeader, flags: number) => void): this;
|
---|
221 | prependOnceListener(event: "push", listener: (headers: IncomingHttpHeaders, flags: number) => void): this;
|
---|
222 | prependOnceListener(event: "response", listener: (headers: IncomingHttpHeaders & IncomingHttpStatusHeader, flags: number) => void): this;
|
---|
223 | prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): this;
|
---|
224 | }
|
---|
225 |
|
---|
226 | export interface ServerHttp2Stream extends Http2Stream {
|
---|
227 | readonly headersSent: boolean;
|
---|
228 | readonly pushAllowed: boolean;
|
---|
229 | additionalHeaders(headers: OutgoingHttpHeaders): void;
|
---|
230 | pushStream(headers: OutgoingHttpHeaders, callback?: (err: Error | null, pushStream: ServerHttp2Stream, headers: OutgoingHttpHeaders) => void): void;
|
---|
231 | pushStream(headers: OutgoingHttpHeaders, options?: StreamPriorityOptions, callback?: (err: Error | null, pushStream: ServerHttp2Stream, headers: OutgoingHttpHeaders) => void): void;
|
---|
232 | respond(headers?: OutgoingHttpHeaders, options?: ServerStreamResponseOptions): void;
|
---|
233 | respondWithFD(fd: number | fs.promises.FileHandle, headers?: OutgoingHttpHeaders, options?: ServerStreamFileResponseOptions): void;
|
---|
234 | respondWithFile(path: string, headers?: OutgoingHttpHeaders, options?: ServerStreamFileResponseOptionsWithError): void;
|
---|
235 | }
|
---|
236 |
|
---|
237 | // Http2Session
|
---|
238 |
|
---|
239 | export interface Settings {
|
---|
240 | headerTableSize?: number | undefined;
|
---|
241 | enablePush?: boolean | undefined;
|
---|
242 | initialWindowSize?: number | undefined;
|
---|
243 | maxFrameSize?: number | undefined;
|
---|
244 | maxConcurrentStreams?: number | undefined;
|
---|
245 | maxHeaderListSize?: number | undefined;
|
---|
246 | enableConnectProtocol?: boolean | undefined;
|
---|
247 | }
|
---|
248 |
|
---|
249 | export interface ClientSessionRequestOptions {
|
---|
250 | endStream?: boolean | undefined;
|
---|
251 | exclusive?: boolean | undefined;
|
---|
252 | parent?: number | undefined;
|
---|
253 | weight?: number | undefined;
|
---|
254 | waitForTrailers?: boolean | undefined;
|
---|
255 | }
|
---|
256 |
|
---|
257 | export interface SessionState {
|
---|
258 | effectiveLocalWindowSize?: number | undefined;
|
---|
259 | effectiveRecvDataLength?: number | undefined;
|
---|
260 | nextStreamID?: number | undefined;
|
---|
261 | localWindowSize?: number | undefined;
|
---|
262 | lastProcStreamID?: number | undefined;
|
---|
263 | remoteWindowSize?: number | undefined;
|
---|
264 | outboundQueueSize?: number | undefined;
|
---|
265 | deflateDynamicTableSize?: number | undefined;
|
---|
266 | inflateDynamicTableSize?: number | undefined;
|
---|
267 | }
|
---|
268 |
|
---|
269 | export interface Http2Session extends EventEmitter {
|
---|
270 | readonly alpnProtocol?: string | undefined;
|
---|
271 | readonly closed: boolean;
|
---|
272 | readonly connecting: boolean;
|
---|
273 | readonly destroyed: boolean;
|
---|
274 | readonly encrypted?: boolean | undefined;
|
---|
275 | readonly localSettings: Settings;
|
---|
276 | readonly originSet?: string[] | undefined;
|
---|
277 | readonly pendingSettingsAck: boolean;
|
---|
278 | readonly remoteSettings: Settings;
|
---|
279 | readonly socket: net.Socket | tls.TLSSocket;
|
---|
280 | readonly state: SessionState;
|
---|
281 | readonly type: number;
|
---|
282 |
|
---|
283 | close(callback?: () => void): void;
|
---|
284 | destroy(error?: Error, code?: number): void;
|
---|
285 | goaway(code?: number, lastStreamID?: number, opaqueData?: NodeJS.ArrayBufferView): void;
|
---|
286 | ping(callback: (err: Error | null, duration: number, payload: Buffer) => void): boolean;
|
---|
287 | ping(payload: NodeJS.ArrayBufferView, callback: (err: Error | null, duration: number, payload: Buffer) => void): boolean;
|
---|
288 | ref(): void;
|
---|
289 | setTimeout(msecs: number, callback?: () => void): void;
|
---|
290 | settings(settings: Settings): void;
|
---|
291 | unref(): void;
|
---|
292 |
|
---|
293 | addListener(event: "close", listener: () => void): this;
|
---|
294 | addListener(event: "error", listener: (err: Error) => void): this;
|
---|
295 | addListener(event: "frameError", listener: (frameType: number, errorCode: number, streamID: number) => void): this;
|
---|
296 | addListener(event: "goaway", listener: (errorCode: number, lastStreamID: number, opaqueData: Buffer) => void): this;
|
---|
297 | addListener(event: "localSettings", listener: (settings: Settings) => void): this;
|
---|
298 | addListener(event: "ping", listener: () => void): this;
|
---|
299 | addListener(event: "remoteSettings", listener: (settings: Settings) => void): this;
|
---|
300 | addListener(event: "timeout", listener: () => void): this;
|
---|
301 | addListener(event: string | symbol, listener: (...args: any[]) => void): this;
|
---|
302 |
|
---|
303 | emit(event: "close"): boolean;
|
---|
304 | emit(event: "error", err: Error): boolean;
|
---|
305 | emit(event: "frameError", frameType: number, errorCode: number, streamID: number): boolean;
|
---|
306 | emit(event: "goaway", errorCode: number, lastStreamID: number, opaqueData: Buffer): boolean;
|
---|
307 | emit(event: "localSettings", settings: Settings): boolean;
|
---|
308 | emit(event: "ping"): boolean;
|
---|
309 | emit(event: "remoteSettings", settings: Settings): boolean;
|
---|
310 | emit(event: "timeout"): boolean;
|
---|
311 | emit(event: string | symbol, ...args: any[]): boolean;
|
---|
312 |
|
---|
313 | on(event: "close", listener: () => void): this;
|
---|
314 | on(event: "error", listener: (err: Error) => void): this;
|
---|
315 | on(event: "frameError", listener: (frameType: number, errorCode: number, streamID: number) => void): this;
|
---|
316 | on(event: "goaway", listener: (errorCode: number, lastStreamID: number, opaqueData: Buffer) => void): this;
|
---|
317 | on(event: "localSettings", listener: (settings: Settings) => void): this;
|
---|
318 | on(event: "ping", listener: () => void): this;
|
---|
319 | on(event: "remoteSettings", listener: (settings: Settings) => void): this;
|
---|
320 | on(event: "timeout", listener: () => void): this;
|
---|
321 | on(event: string | symbol, listener: (...args: any[]) => void): this;
|
---|
322 |
|
---|
323 | once(event: "close", listener: () => void): this;
|
---|
324 | once(event: "error", listener: (err: Error) => void): this;
|
---|
325 | once(event: "frameError", listener: (frameType: number, errorCode: number, streamID: number) => void): this;
|
---|
326 | once(event: "goaway", listener: (errorCode: number, lastStreamID: number, opaqueData: Buffer) => void): this;
|
---|
327 | once(event: "localSettings", listener: (settings: Settings) => void): this;
|
---|
328 | once(event: "ping", listener: () => void): this;
|
---|
329 | once(event: "remoteSettings", listener: (settings: Settings) => void): this;
|
---|
330 | once(event: "timeout", listener: () => void): this;
|
---|
331 | once(event: string | symbol, listener: (...args: any[]) => void): this;
|
---|
332 |
|
---|
333 | prependListener(event: "close", listener: () => void): this;
|
---|
334 | prependListener(event: "error", listener: (err: Error) => void): this;
|
---|
335 | prependListener(event: "frameError", listener: (frameType: number, errorCode: number, streamID: number) => void): this;
|
---|
336 | prependListener(event: "goaway", listener: (errorCode: number, lastStreamID: number, opaqueData: Buffer) => void): this;
|
---|
337 | prependListener(event: "localSettings", listener: (settings: Settings) => void): this;
|
---|
338 | prependListener(event: "ping", listener: () => void): this;
|
---|
339 | prependListener(event: "remoteSettings", listener: (settings: Settings) => void): this;
|
---|
340 | prependListener(event: "timeout", listener: () => void): this;
|
---|
341 | prependListener(event: string | symbol, listener: (...args: any[]) => void): this;
|
---|
342 |
|
---|
343 | prependOnceListener(event: "close", listener: () => void): this;
|
---|
344 | prependOnceListener(event: "error", listener: (err: Error) => void): this;
|
---|
345 | prependOnceListener(event: "frameError", listener: (frameType: number, errorCode: number, streamID: number) => void): this;
|
---|
346 | prependOnceListener(event: "goaway", listener: (errorCode: number, lastStreamID: number, opaqueData: Buffer) => void): this;
|
---|
347 | prependOnceListener(event: "localSettings", listener: (settings: Settings) => void): this;
|
---|
348 | prependOnceListener(event: "ping", listener: () => void): this;
|
---|
349 | prependOnceListener(event: "remoteSettings", listener: (settings: Settings) => void): this;
|
---|
350 | prependOnceListener(event: "timeout", listener: () => void): this;
|
---|
351 | prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): this;
|
---|
352 | }
|
---|
353 |
|
---|
354 | export interface ClientHttp2Session extends Http2Session {
|
---|
355 | request(headers?: OutgoingHttpHeaders, options?: ClientSessionRequestOptions): ClientHttp2Stream;
|
---|
356 |
|
---|
357 | addListener(event: "altsvc", listener: (alt: string, origin: string, stream: number) => void): this;
|
---|
358 | addListener(event: "origin", listener: (origins: string[]) => void): this;
|
---|
359 | addListener(event: "connect", listener: (session: ClientHttp2Session, socket: net.Socket | tls.TLSSocket) => void): this;
|
---|
360 | addListener(event: "stream", listener: (stream: ClientHttp2Stream, headers: IncomingHttpHeaders & IncomingHttpStatusHeader, flags: number) => void): this;
|
---|
361 | addListener(event: string | symbol, listener: (...args: any[]) => void): this;
|
---|
362 |
|
---|
363 | emit(event: "altsvc", alt: string, origin: string, stream: number): boolean;
|
---|
364 | emit(event: "origin", origins: ReadonlyArray<string>): boolean;
|
---|
365 | emit(event: "connect", session: ClientHttp2Session, socket: net.Socket | tls.TLSSocket): boolean;
|
---|
366 | emit(event: "stream", stream: ClientHttp2Stream, headers: IncomingHttpHeaders & IncomingHttpStatusHeader, flags: number): boolean;
|
---|
367 | emit(event: string | symbol, ...args: any[]): boolean;
|
---|
368 |
|
---|
369 | on(event: "altsvc", listener: (alt: string, origin: string, stream: number) => void): this;
|
---|
370 | on(event: "origin", listener: (origins: string[]) => void): this;
|
---|
371 | on(event: "connect", listener: (session: ClientHttp2Session, socket: net.Socket | tls.TLSSocket) => void): this;
|
---|
372 | on(event: "stream", listener: (stream: ClientHttp2Stream, headers: IncomingHttpHeaders & IncomingHttpStatusHeader, flags: number) => void): this;
|
---|
373 | on(event: string | symbol, listener: (...args: any[]) => void): this;
|
---|
374 |
|
---|
375 | once(event: "altsvc", listener: (alt: string, origin: string, stream: number) => void): this;
|
---|
376 | once(event: "origin", listener: (origins: string[]) => void): this;
|
---|
377 | once(event: "connect", listener: (session: ClientHttp2Session, socket: net.Socket | tls.TLSSocket) => void): this;
|
---|
378 | once(event: "stream", listener: (stream: ClientHttp2Stream, headers: IncomingHttpHeaders & IncomingHttpStatusHeader, flags: number) => void): this;
|
---|
379 | once(event: string | symbol, listener: (...args: any[]) => void): this;
|
---|
380 |
|
---|
381 | prependListener(event: "altsvc", listener: (alt: string, origin: string, stream: number) => void): this;
|
---|
382 | prependListener(event: "origin", listener: (origins: string[]) => void): this;
|
---|
383 | prependListener(event: "connect", listener: (session: ClientHttp2Session, socket: net.Socket | tls.TLSSocket) => void): this;
|
---|
384 | prependListener(event: "stream", listener: (stream: ClientHttp2Stream, headers: IncomingHttpHeaders & IncomingHttpStatusHeader, flags: number) => void): this;
|
---|
385 | prependListener(event: string | symbol, listener: (...args: any[]) => void): this;
|
---|
386 |
|
---|
387 | prependOnceListener(event: "altsvc", listener: (alt: string, origin: string, stream: number) => void): this;
|
---|
388 | prependOnceListener(event: "origin", listener: (origins: string[]) => void): this;
|
---|
389 | prependOnceListener(event: "connect", listener: (session: ClientHttp2Session, socket: net.Socket | tls.TLSSocket) => void): this;
|
---|
390 | prependOnceListener(event: "stream", listener: (stream: ClientHttp2Stream, headers: IncomingHttpHeaders & IncomingHttpStatusHeader, flags: number) => void): this;
|
---|
391 | prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): this;
|
---|
392 | }
|
---|
393 |
|
---|
394 | export interface AlternativeServiceOptions {
|
---|
395 | origin: number | string | url.URL;
|
---|
396 | }
|
---|
397 |
|
---|
398 | export interface ServerHttp2Session extends Http2Session {
|
---|
399 | readonly server: Http2Server | Http2SecureServer;
|
---|
400 |
|
---|
401 | altsvc(alt: string, originOrStream: number | string | url.URL | AlternativeServiceOptions): void;
|
---|
402 | origin(...args: Array<string | url.URL | { origin: string }>): void;
|
---|
403 |
|
---|
404 | addListener(event: "connect", listener: (session: ServerHttp2Session, socket: net.Socket | tls.TLSSocket) => void): this;
|
---|
405 | addListener(event: "stream", listener: (stream: ServerHttp2Stream, headers: IncomingHttpHeaders, flags: number) => void): this;
|
---|
406 | addListener(event: string | symbol, listener: (...args: any[]) => void): this;
|
---|
407 |
|
---|
408 | emit(event: "connect", session: ServerHttp2Session, socket: net.Socket | tls.TLSSocket): boolean;
|
---|
409 | emit(event: "stream", stream: ServerHttp2Stream, headers: IncomingHttpHeaders, flags: number): boolean;
|
---|
410 | emit(event: string | symbol, ...args: any[]): boolean;
|
---|
411 |
|
---|
412 | on(event: "connect", listener: (session: ServerHttp2Session, socket: net.Socket | tls.TLSSocket) => void): this;
|
---|
413 | on(event: "stream", listener: (stream: ServerHttp2Stream, headers: IncomingHttpHeaders, flags: number) => void): this;
|
---|
414 | on(event: string | symbol, listener: (...args: any[]) => void): this;
|
---|
415 |
|
---|
416 | once(event: "connect", listener: (session: ServerHttp2Session, socket: net.Socket | tls.TLSSocket) => void): this;
|
---|
417 | once(event: "stream", listener: (stream: ServerHttp2Stream, headers: IncomingHttpHeaders, flags: number) => void): this;
|
---|
418 | once(event: string | symbol, listener: (...args: any[]) => void): this;
|
---|
419 |
|
---|
420 | prependListener(event: "connect", listener: (session: ServerHttp2Session, socket: net.Socket | tls.TLSSocket) => void): this;
|
---|
421 | prependListener(event: "stream", listener: (stream: ServerHttp2Stream, headers: IncomingHttpHeaders, flags: number) => void): this;
|
---|
422 | prependListener(event: string | symbol, listener: (...args: any[]) => void): this;
|
---|
423 |
|
---|
424 | prependOnceListener(event: "connect", listener: (session: ServerHttp2Session, socket: net.Socket | tls.TLSSocket) => void): this;
|
---|
425 | prependOnceListener(event: "stream", listener: (stream: ServerHttp2Stream, headers: IncomingHttpHeaders, flags: number) => void): this;
|
---|
426 | prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): this;
|
---|
427 | }
|
---|
428 |
|
---|
429 | // Http2Server
|
---|
430 |
|
---|
431 | export interface SessionOptions {
|
---|
432 | maxDeflateDynamicTableSize?: number | undefined;
|
---|
433 | maxSessionMemory?: number | undefined;
|
---|
434 | maxHeaderListPairs?: number | undefined;
|
---|
435 | maxOutstandingPings?: number | undefined;
|
---|
436 | maxSendHeaderBlockLength?: number | undefined;
|
---|
437 | paddingStrategy?: number | undefined;
|
---|
438 | peerMaxConcurrentStreams?: number | undefined;
|
---|
439 | settings?: Settings | undefined;
|
---|
440 |
|
---|
441 | selectPadding?(frameLen: number, maxFrameLen: number): number;
|
---|
442 | createConnection?(authority: url.URL, option: SessionOptions): stream.Duplex;
|
---|
443 | }
|
---|
444 |
|
---|
445 | export interface ClientSessionOptions extends SessionOptions {
|
---|
446 | maxReservedRemoteStreams?: number | undefined;
|
---|
447 | createConnection?: ((authority: url.URL, option: SessionOptions) => stream.Duplex) | undefined;
|
---|
448 | }
|
---|
449 |
|
---|
450 | export interface ServerSessionOptions extends SessionOptions {
|
---|
451 | Http1IncomingMessage?: typeof IncomingMessage | undefined;
|
---|
452 | Http1ServerResponse?: typeof ServerResponse | undefined;
|
---|
453 | Http2ServerRequest?: typeof Http2ServerRequest | undefined;
|
---|
454 | Http2ServerResponse?: typeof Http2ServerResponse | undefined;
|
---|
455 | }
|
---|
456 |
|
---|
457 | export interface SecureClientSessionOptions extends ClientSessionOptions, tls.ConnectionOptions { }
|
---|
458 | export interface SecureServerSessionOptions extends ServerSessionOptions, tls.TlsOptions { }
|
---|
459 |
|
---|
460 | export interface ServerOptions extends ServerSessionOptions { }
|
---|
461 |
|
---|
462 | export interface SecureServerOptions extends SecureServerSessionOptions {
|
---|
463 | allowHTTP1?: boolean | undefined;
|
---|
464 | origins?: string[] | undefined;
|
---|
465 | }
|
---|
466 |
|
---|
467 | export interface Http2Server extends net.Server {
|
---|
468 | addListener(event: "checkContinue", listener: (request: Http2ServerRequest, response: Http2ServerResponse) => void): this;
|
---|
469 | addListener(event: "request", listener: (request: Http2ServerRequest, response: Http2ServerResponse) => void): this;
|
---|
470 | addListener(event: "session", listener: (session: ServerHttp2Session) => void): this;
|
---|
471 | addListener(event: "sessionError", listener: (err: Error) => void): this;
|
---|
472 | addListener(event: "stream", listener: (stream: ServerHttp2Stream, headers: IncomingHttpHeaders, flags: number) => void): this;
|
---|
473 | addListener(event: "timeout", listener: () => void): this;
|
---|
474 | addListener(event: string | symbol, listener: (...args: any[]) => void): this;
|
---|
475 |
|
---|
476 | emit(event: "checkContinue", request: Http2ServerRequest, response: Http2ServerResponse): boolean;
|
---|
477 | emit(event: "request", request: Http2ServerRequest, response: Http2ServerResponse): boolean;
|
---|
478 | emit(event: "session", session: ServerHttp2Session): boolean;
|
---|
479 | emit(event: "sessionError", err: Error): boolean;
|
---|
480 | emit(event: "stream", stream: ServerHttp2Stream, headers: IncomingHttpHeaders, flags: number): boolean;
|
---|
481 | emit(event: "timeout"): boolean;
|
---|
482 | emit(event: string | symbol, ...args: any[]): boolean;
|
---|
483 |
|
---|
484 | on(event: "checkContinue", listener: (request: Http2ServerRequest, response: Http2ServerResponse) => void): this;
|
---|
485 | on(event: "request", listener: (request: Http2ServerRequest, response: Http2ServerResponse) => void): this;
|
---|
486 | on(event: "session", listener: (session: ServerHttp2Session) => void): this;
|
---|
487 | on(event: "sessionError", listener: (err: Error) => void): this;
|
---|
488 | on(event: "stream", listener: (stream: ServerHttp2Stream, headers: IncomingHttpHeaders, flags: number) => void): this;
|
---|
489 | on(event: "timeout", listener: () => void): this;
|
---|
490 | on(event: string | symbol, listener: (...args: any[]) => void): this;
|
---|
491 |
|
---|
492 | once(event: "checkContinue", listener: (request: Http2ServerRequest, response: Http2ServerResponse) => void): this;
|
---|
493 | once(event: "request", listener: (request: Http2ServerRequest, response: Http2ServerResponse) => void): this;
|
---|
494 | once(event: "session", listener: (session: ServerHttp2Session) => void): this;
|
---|
495 | once(event: "sessionError", listener: (err: Error) => void): this;
|
---|
496 | once(event: "stream", listener: (stream: ServerHttp2Stream, headers: IncomingHttpHeaders, flags: number) => void): this;
|
---|
497 | once(event: "timeout", listener: () => void): this;
|
---|
498 | once(event: string | symbol, listener: (...args: any[]) => void): this;
|
---|
499 |
|
---|
500 | prependListener(event: "checkContinue", listener: (request: Http2ServerRequest, response: Http2ServerResponse) => void): this;
|
---|
501 | prependListener(event: "request", listener: (request: Http2ServerRequest, response: Http2ServerResponse) => void): this;
|
---|
502 | prependListener(event: "session", listener: (session: ServerHttp2Session) => void): this;
|
---|
503 | prependListener(event: "sessionError", listener: (err: Error) => void): this;
|
---|
504 | prependListener(event: "stream", listener: (stream: ServerHttp2Stream, headers: IncomingHttpHeaders, flags: number) => void): this;
|
---|
505 | prependListener(event: "timeout", listener: () => void): this;
|
---|
506 | prependListener(event: string | symbol, listener: (...args: any[]) => void): this;
|
---|
507 |
|
---|
508 | prependOnceListener(event: "checkContinue", listener: (request: Http2ServerRequest, response: Http2ServerResponse) => void): this;
|
---|
509 | prependOnceListener(event: "request", listener: (request: Http2ServerRequest, response: Http2ServerResponse) => void): this;
|
---|
510 | prependOnceListener(event: "session", listener: (session: ServerHttp2Session) => void): this;
|
---|
511 | prependOnceListener(event: "sessionError", listener: (err: Error) => void): this;
|
---|
512 | prependOnceListener(event: "stream", listener: (stream: ServerHttp2Stream, headers: IncomingHttpHeaders, flags: number) => void): this;
|
---|
513 | prependOnceListener(event: "timeout", listener: () => void): this;
|
---|
514 | prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): this;
|
---|
515 |
|
---|
516 | setTimeout(msec?: number, callback?: () => void): this;
|
---|
517 | }
|
---|
518 |
|
---|
519 | export interface Http2SecureServer extends tls.Server {
|
---|
520 | addListener(event: "checkContinue", listener: (request: Http2ServerRequest, response: Http2ServerResponse) => void): this;
|
---|
521 | addListener(event: "request", listener: (request: Http2ServerRequest, response: Http2ServerResponse) => void): this;
|
---|
522 | addListener(event: "session", listener: (session: ServerHttp2Session) => void): this;
|
---|
523 | addListener(event: "sessionError", listener: (err: Error) => void): this;
|
---|
524 | addListener(event: "stream", listener: (stream: ServerHttp2Stream, headers: IncomingHttpHeaders, flags: number) => void): this;
|
---|
525 | addListener(event: "timeout", listener: () => void): this;
|
---|
526 | addListener(event: "unknownProtocol", listener: (socket: tls.TLSSocket) => void): this;
|
---|
527 | addListener(event: string | symbol, listener: (...args: any[]) => void): this;
|
---|
528 |
|
---|
529 | emit(event: "checkContinue", request: Http2ServerRequest, response: Http2ServerResponse): boolean;
|
---|
530 | emit(event: "request", request: Http2ServerRequest, response: Http2ServerResponse): boolean;
|
---|
531 | emit(event: "session", session: ServerHttp2Session): boolean;
|
---|
532 | emit(event: "sessionError", err: Error): boolean;
|
---|
533 | emit(event: "stream", stream: ServerHttp2Stream, headers: IncomingHttpHeaders, flags: number): boolean;
|
---|
534 | emit(event: "timeout"): boolean;
|
---|
535 | emit(event: "unknownProtocol", socket: tls.TLSSocket): boolean;
|
---|
536 | emit(event: string | symbol, ...args: any[]): boolean;
|
---|
537 |
|
---|
538 | on(event: "checkContinue", listener: (request: Http2ServerRequest, response: Http2ServerResponse) => void): this;
|
---|
539 | on(event: "request", listener: (request: Http2ServerRequest, response: Http2ServerResponse) => void): this;
|
---|
540 | on(event: "session", listener: (session: ServerHttp2Session) => void): this;
|
---|
541 | on(event: "sessionError", listener: (err: Error) => void): this;
|
---|
542 | on(event: "stream", listener: (stream: ServerHttp2Stream, headers: IncomingHttpHeaders, flags: number) => void): this;
|
---|
543 | on(event: "timeout", listener: () => void): this;
|
---|
544 | on(event: "unknownProtocol", listener: (socket: tls.TLSSocket) => void): this;
|
---|
545 | on(event: string | symbol, listener: (...args: any[]) => void): this;
|
---|
546 |
|
---|
547 | once(event: "checkContinue", listener: (request: Http2ServerRequest, response: Http2ServerResponse) => void): this;
|
---|
548 | once(event: "request", listener: (request: Http2ServerRequest, response: Http2ServerResponse) => void): this;
|
---|
549 | once(event: "session", listener: (session: ServerHttp2Session) => void): this;
|
---|
550 | once(event: "sessionError", listener: (err: Error) => void): this;
|
---|
551 | once(event: "stream", listener: (stream: ServerHttp2Stream, headers: IncomingHttpHeaders, flags: number) => void): this;
|
---|
552 | once(event: "timeout", listener: () => void): this;
|
---|
553 | once(event: "unknownProtocol", listener: (socket: tls.TLSSocket) => void): this;
|
---|
554 | once(event: string | symbol, listener: (...args: any[]) => void): this;
|
---|
555 |
|
---|
556 | prependListener(event: "checkContinue", listener: (request: Http2ServerRequest, response: Http2ServerResponse) => void): this;
|
---|
557 | prependListener(event: "request", listener: (request: Http2ServerRequest, response: Http2ServerResponse) => void): this;
|
---|
558 | prependListener(event: "session", listener: (session: ServerHttp2Session) => void): this;
|
---|
559 | prependListener(event: "sessionError", listener: (err: Error) => void): this;
|
---|
560 | prependListener(event: "stream", listener: (stream: ServerHttp2Stream, headers: IncomingHttpHeaders, flags: number) => void): this;
|
---|
561 | prependListener(event: "timeout", listener: () => void): this;
|
---|
562 | prependListener(event: "unknownProtocol", listener: (socket: tls.TLSSocket) => void): this;
|
---|
563 | prependListener(event: string | symbol, listener: (...args: any[]) => void): this;
|
---|
564 |
|
---|
565 | prependOnceListener(event: "checkContinue", listener: (request: Http2ServerRequest, response: Http2ServerResponse) => void): this;
|
---|
566 | prependOnceListener(event: "request", listener: (request: Http2ServerRequest, response: Http2ServerResponse) => void): this;
|
---|
567 | prependOnceListener(event: "session", listener: (session: ServerHttp2Session) => void): this;
|
---|
568 | prependOnceListener(event: "sessionError", listener: (err: Error) => void): this;
|
---|
569 | prependOnceListener(event: "stream", listener: (stream: ServerHttp2Stream, headers: IncomingHttpHeaders, flags: number) => void): this;
|
---|
570 | prependOnceListener(event: "timeout", listener: () => void): this;
|
---|
571 | prependOnceListener(event: "unknownProtocol", listener: (socket: tls.TLSSocket) => void): this;
|
---|
572 | prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): this;
|
---|
573 |
|
---|
574 | setTimeout(msec?: number, callback?: () => void): this;
|
---|
575 | }
|
---|
576 |
|
---|
577 | export class Http2ServerRequest extends stream.Readable {
|
---|
578 | constructor(stream: ServerHttp2Stream, headers: IncomingHttpHeaders, options: stream.ReadableOptions, rawHeaders: ReadonlyArray<string>);
|
---|
579 |
|
---|
580 | readonly aborted: boolean;
|
---|
581 | readonly authority: string;
|
---|
582 | readonly headers: IncomingHttpHeaders;
|
---|
583 | readonly httpVersion: string;
|
---|
584 | readonly method: string;
|
---|
585 | readonly rawHeaders: string[];
|
---|
586 | readonly rawTrailers: string[];
|
---|
587 | readonly scheme: string;
|
---|
588 | readonly socket: net.Socket | tls.TLSSocket;
|
---|
589 | readonly stream: ServerHttp2Stream;
|
---|
590 | readonly trailers: IncomingHttpHeaders;
|
---|
591 | readonly url: string;
|
---|
592 |
|
---|
593 | setTimeout(msecs: number, callback?: () => void): void;
|
---|
594 | read(size?: number): Buffer | string | null;
|
---|
595 |
|
---|
596 | addListener(event: "aborted", listener: (hadError: boolean, code: number) => void): this;
|
---|
597 | addListener(event: "close", listener: () => void): this;
|
---|
598 | addListener(event: "data", listener: (chunk: Buffer | string) => void): this;
|
---|
599 | addListener(event: "end", listener: () => void): this;
|
---|
600 | addListener(event: "readable", listener: () => void): this;
|
---|
601 | addListener(event: "error", listener: (err: Error) => void): this;
|
---|
602 | addListener(event: string | symbol, listener: (...args: any[]) => void): this;
|
---|
603 |
|
---|
604 | emit(event: "aborted", hadError: boolean, code: number): boolean;
|
---|
605 | emit(event: "close"): boolean;
|
---|
606 | emit(event: "data", chunk: Buffer | string): boolean;
|
---|
607 | emit(event: "end"): boolean;
|
---|
608 | emit(event: "readable"): boolean;
|
---|
609 | emit(event: "error", err: Error): boolean;
|
---|
610 | emit(event: string | symbol, ...args: any[]): boolean;
|
---|
611 |
|
---|
612 | on(event: "aborted", listener: (hadError: boolean, code: number) => void): this;
|
---|
613 | on(event: "close", listener: () => void): this;
|
---|
614 | on(event: "data", listener: (chunk: Buffer | string) => void): this;
|
---|
615 | on(event: "end", listener: () => void): this;
|
---|
616 | on(event: "readable", listener: () => void): this;
|
---|
617 | on(event: "error", listener: (err: Error) => void): this;
|
---|
618 | on(event: string | symbol, listener: (...args: any[]) => void): this;
|
---|
619 |
|
---|
620 | once(event: "aborted", listener: (hadError: boolean, code: number) => void): this;
|
---|
621 | once(event: "close", listener: () => void): this;
|
---|
622 | once(event: "data", listener: (chunk: Buffer | string) => void): this;
|
---|
623 | once(event: "end", listener: () => void): this;
|
---|
624 | once(event: "readable", listener: () => void): this;
|
---|
625 | once(event: "error", listener: (err: Error) => void): this;
|
---|
626 | once(event: string | symbol, listener: (...args: any[]) => void): this;
|
---|
627 |
|
---|
628 | prependListener(event: "aborted", listener: (hadError: boolean, code: number) => void): this;
|
---|
629 | prependListener(event: "close", listener: () => void): this;
|
---|
630 | prependListener(event: "data", listener: (chunk: Buffer | string) => void): this;
|
---|
631 | prependListener(event: "end", listener: () => void): this;
|
---|
632 | prependListener(event: "readable", listener: () => void): this;
|
---|
633 | prependListener(event: "error", listener: (err: Error) => void): this;
|
---|
634 | prependListener(event: string | symbol, listener: (...args: any[]) => void): this;
|
---|
635 |
|
---|
636 | prependOnceListener(event: "aborted", listener: (hadError: boolean, code: number) => void): this;
|
---|
637 | prependOnceListener(event: "close", listener: () => void): this;
|
---|
638 | prependOnceListener(event: "data", listener: (chunk: Buffer | string) => void): this;
|
---|
639 | prependOnceListener(event: "end", listener: () => void): this;
|
---|
640 | prependOnceListener(event: "readable", listener: () => void): this;
|
---|
641 | prependOnceListener(event: "error", listener: (err: Error) => void): this;
|
---|
642 | prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): this;
|
---|
643 | }
|
---|
644 |
|
---|
645 | export class Http2ServerResponse extends stream.Writable {
|
---|
646 | constructor(stream: ServerHttp2Stream);
|
---|
647 |
|
---|
648 | readonly connection: net.Socket | tls.TLSSocket;
|
---|
649 | readonly finished: boolean;
|
---|
650 | readonly headersSent: boolean;
|
---|
651 | readonly socket: net.Socket | tls.TLSSocket;
|
---|
652 | readonly stream: ServerHttp2Stream;
|
---|
653 | sendDate: boolean;
|
---|
654 | statusCode: number;
|
---|
655 | statusMessage: '';
|
---|
656 | addTrailers(trailers: OutgoingHttpHeaders): void;
|
---|
657 | end(callback?: () => void): void;
|
---|
658 | end(data: string | Uint8Array, callback?: () => void): void;
|
---|
659 | end(data: string | Uint8Array, encoding: string, callback?: () => void): void;
|
---|
660 | getHeader(name: string): string;
|
---|
661 | getHeaderNames(): string[];
|
---|
662 | getHeaders(): OutgoingHttpHeaders;
|
---|
663 | hasHeader(name: string): boolean;
|
---|
664 | removeHeader(name: string): void;
|
---|
665 | setHeader(name: string, value: number | string | ReadonlyArray<string>): void;
|
---|
666 | setTimeout(msecs: number, callback?: () => void): void;
|
---|
667 | write(chunk: string | Uint8Array, callback?: (err: Error) => void): boolean;
|
---|
668 | write(chunk: string | Uint8Array, encoding: string, callback?: (err: Error) => void): boolean;
|
---|
669 | writeContinue(): void;
|
---|
670 | writeHead(statusCode: number, headers?: OutgoingHttpHeaders): this;
|
---|
671 | writeHead(statusCode: number, statusMessage: string, headers?: OutgoingHttpHeaders): this;
|
---|
672 | createPushResponse(headers: OutgoingHttpHeaders, callback: (err: Error | null, res: Http2ServerResponse) => void): void;
|
---|
673 |
|
---|
674 | addListener(event: "close", listener: () => void): this;
|
---|
675 | addListener(event: "drain", listener: () => void): this;
|
---|
676 | addListener(event: "error", listener: (error: Error) => void): this;
|
---|
677 | addListener(event: "finish", listener: () => void): this;
|
---|
678 | addListener(event: "pipe", listener: (src: stream.Readable) => void): this;
|
---|
679 | addListener(event: "unpipe", listener: (src: stream.Readable) => void): this;
|
---|
680 | addListener(event: string | symbol, listener: (...args: any[]) => void): this;
|
---|
681 |
|
---|
682 | emit(event: "close"): boolean;
|
---|
683 | emit(event: "drain"): boolean;
|
---|
684 | emit(event: "error", error: Error): boolean;
|
---|
685 | emit(event: "finish"): boolean;
|
---|
686 | emit(event: "pipe", src: stream.Readable): boolean;
|
---|
687 | emit(event: "unpipe", src: stream.Readable): boolean;
|
---|
688 | emit(event: string | symbol, ...args: any[]): boolean;
|
---|
689 |
|
---|
690 | on(event: "close", listener: () => void): this;
|
---|
691 | on(event: "drain", listener: () => void): this;
|
---|
692 | on(event: "error", listener: (error: Error) => void): this;
|
---|
693 | on(event: "finish", listener: () => void): this;
|
---|
694 | on(event: "pipe", listener: (src: stream.Readable) => void): this;
|
---|
695 | on(event: "unpipe", listener: (src: stream.Readable) => void): this;
|
---|
696 | on(event: string | symbol, listener: (...args: any[]) => void): this;
|
---|
697 |
|
---|
698 | once(event: "close", listener: () => void): this;
|
---|
699 | once(event: "drain", listener: () => void): this;
|
---|
700 | once(event: "error", listener: (error: Error) => void): this;
|
---|
701 | once(event: "finish", listener: () => void): this;
|
---|
702 | once(event: "pipe", listener: (src: stream.Readable) => void): this;
|
---|
703 | once(event: "unpipe", listener: (src: stream.Readable) => void): this;
|
---|
704 | once(event: string | symbol, listener: (...args: any[]) => void): this;
|
---|
705 |
|
---|
706 | prependListener(event: "close", listener: () => void): this;
|
---|
707 | prependListener(event: "drain", listener: () => void): this;
|
---|
708 | prependListener(event: "error", listener: (error: Error) => void): this;
|
---|
709 | prependListener(event: "finish", listener: () => void): this;
|
---|
710 | prependListener(event: "pipe", listener: (src: stream.Readable) => void): this;
|
---|
711 | prependListener(event: "unpipe", listener: (src: stream.Readable) => void): this;
|
---|
712 | prependListener(event: string | symbol, listener: (...args: any[]) => void): this;
|
---|
713 |
|
---|
714 | prependOnceListener(event: "close", listener: () => void): this;
|
---|
715 | prependOnceListener(event: "drain", listener: () => void): this;
|
---|
716 | prependOnceListener(event: "error", listener: (error: Error) => void): this;
|
---|
717 | prependOnceListener(event: "finish", listener: () => void): this;
|
---|
718 | prependOnceListener(event: "pipe", listener: (src: stream.Readable) => void): this;
|
---|
719 | prependOnceListener(event: "unpipe", listener: (src: stream.Readable) => void): this;
|
---|
720 | prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): this;
|
---|
721 | }
|
---|
722 |
|
---|
723 | // Public API
|
---|
724 |
|
---|
725 | export namespace constants {
|
---|
726 | const NGHTTP2_SESSION_SERVER: number;
|
---|
727 | const NGHTTP2_SESSION_CLIENT: number;
|
---|
728 | const NGHTTP2_STREAM_STATE_IDLE: number;
|
---|
729 | const NGHTTP2_STREAM_STATE_OPEN: number;
|
---|
730 | const NGHTTP2_STREAM_STATE_RESERVED_LOCAL: number;
|
---|
731 | const NGHTTP2_STREAM_STATE_RESERVED_REMOTE: number;
|
---|
732 | const NGHTTP2_STREAM_STATE_HALF_CLOSED_LOCAL: number;
|
---|
733 | const NGHTTP2_STREAM_STATE_HALF_CLOSED_REMOTE: number;
|
---|
734 | const NGHTTP2_STREAM_STATE_CLOSED: number;
|
---|
735 | const NGHTTP2_NO_ERROR: number;
|
---|
736 | const NGHTTP2_PROTOCOL_ERROR: number;
|
---|
737 | const NGHTTP2_INTERNAL_ERROR: number;
|
---|
738 | const NGHTTP2_FLOW_CONTROL_ERROR: number;
|
---|
739 | const NGHTTP2_SETTINGS_TIMEOUT: number;
|
---|
740 | const NGHTTP2_STREAM_CLOSED: number;
|
---|
741 | const NGHTTP2_FRAME_SIZE_ERROR: number;
|
---|
742 | const NGHTTP2_REFUSED_STREAM: number;
|
---|
743 | const NGHTTP2_CANCEL: number;
|
---|
744 | const NGHTTP2_COMPRESSION_ERROR: number;
|
---|
745 | const NGHTTP2_CONNECT_ERROR: number;
|
---|
746 | const NGHTTP2_ENHANCE_YOUR_CALM: number;
|
---|
747 | const NGHTTP2_INADEQUATE_SECURITY: number;
|
---|
748 | const NGHTTP2_HTTP_1_1_REQUIRED: number;
|
---|
749 | const NGHTTP2_ERR_FRAME_SIZE_ERROR: number;
|
---|
750 | const NGHTTP2_FLAG_NONE: number;
|
---|
751 | const NGHTTP2_FLAG_END_STREAM: number;
|
---|
752 | const NGHTTP2_FLAG_END_HEADERS: number;
|
---|
753 | const NGHTTP2_FLAG_ACK: number;
|
---|
754 | const NGHTTP2_FLAG_PADDED: number;
|
---|
755 | const NGHTTP2_FLAG_PRIORITY: number;
|
---|
756 | const DEFAULT_SETTINGS_HEADER_TABLE_SIZE: number;
|
---|
757 | const DEFAULT_SETTINGS_ENABLE_PUSH: number;
|
---|
758 | const DEFAULT_SETTINGS_INITIAL_WINDOW_SIZE: number;
|
---|
759 | const DEFAULT_SETTINGS_MAX_FRAME_SIZE: number;
|
---|
760 | const MAX_MAX_FRAME_SIZE: number;
|
---|
761 | const MIN_MAX_FRAME_SIZE: number;
|
---|
762 | const MAX_INITIAL_WINDOW_SIZE: number;
|
---|
763 | const NGHTTP2_DEFAULT_WEIGHT: number;
|
---|
764 | const NGHTTP2_SETTINGS_HEADER_TABLE_SIZE: number;
|
---|
765 | const NGHTTP2_SETTINGS_ENABLE_PUSH: number;
|
---|
766 | const NGHTTP2_SETTINGS_MAX_CONCURRENT_STREAMS: number;
|
---|
767 | const NGHTTP2_SETTINGS_INITIAL_WINDOW_SIZE: number;
|
---|
768 | const NGHTTP2_SETTINGS_MAX_FRAME_SIZE: number;
|
---|
769 | const NGHTTP2_SETTINGS_MAX_HEADER_LIST_SIZE: number;
|
---|
770 | const PADDING_STRATEGY_NONE: number;
|
---|
771 | const PADDING_STRATEGY_MAX: number;
|
---|
772 | const PADDING_STRATEGY_CALLBACK: number;
|
---|
773 | const HTTP2_HEADER_STATUS: string;
|
---|
774 | const HTTP2_HEADER_METHOD: string;
|
---|
775 | const HTTP2_HEADER_AUTHORITY: string;
|
---|
776 | const HTTP2_HEADER_SCHEME: string;
|
---|
777 | const HTTP2_HEADER_PATH: string;
|
---|
778 | const HTTP2_HEADER_ACCEPT_CHARSET: string;
|
---|
779 | const HTTP2_HEADER_ACCEPT_ENCODING: string;
|
---|
780 | const HTTP2_HEADER_ACCEPT_LANGUAGE: string;
|
---|
781 | const HTTP2_HEADER_ACCEPT_RANGES: string;
|
---|
782 | const HTTP2_HEADER_ACCEPT: string;
|
---|
783 | const HTTP2_HEADER_ACCESS_CONTROL_ALLOW_ORIGIN: string;
|
---|
784 | const HTTP2_HEADER_AGE: string;
|
---|
785 | const HTTP2_HEADER_ALLOW: string;
|
---|
786 | const HTTP2_HEADER_AUTHORIZATION: string;
|
---|
787 | const HTTP2_HEADER_CACHE_CONTROL: string;
|
---|
788 | const HTTP2_HEADER_CONNECTION: string;
|
---|
789 | const HTTP2_HEADER_CONTENT_DISPOSITION: string;
|
---|
790 | const HTTP2_HEADER_CONTENT_ENCODING: string;
|
---|
791 | const HTTP2_HEADER_CONTENT_LANGUAGE: string;
|
---|
792 | const HTTP2_HEADER_CONTENT_LENGTH: string;
|
---|
793 | const HTTP2_HEADER_CONTENT_LOCATION: string;
|
---|
794 | const HTTP2_HEADER_CONTENT_MD5: string;
|
---|
795 | const HTTP2_HEADER_CONTENT_RANGE: string;
|
---|
796 | const HTTP2_HEADER_CONTENT_TYPE: string;
|
---|
797 | const HTTP2_HEADER_COOKIE: string;
|
---|
798 | const HTTP2_HEADER_DATE: string;
|
---|
799 | const HTTP2_HEADER_ETAG: string;
|
---|
800 | const HTTP2_HEADER_EXPECT: string;
|
---|
801 | const HTTP2_HEADER_EXPIRES: string;
|
---|
802 | const HTTP2_HEADER_FROM: string;
|
---|
803 | const HTTP2_HEADER_HOST: string;
|
---|
804 | const HTTP2_HEADER_IF_MATCH: string;
|
---|
805 | const HTTP2_HEADER_IF_MODIFIED_SINCE: string;
|
---|
806 | const HTTP2_HEADER_IF_NONE_MATCH: string;
|
---|
807 | const HTTP2_HEADER_IF_RANGE: string;
|
---|
808 | const HTTP2_HEADER_IF_UNMODIFIED_SINCE: string;
|
---|
809 | const HTTP2_HEADER_LAST_MODIFIED: string;
|
---|
810 | const HTTP2_HEADER_LINK: string;
|
---|
811 | const HTTP2_HEADER_LOCATION: string;
|
---|
812 | const HTTP2_HEADER_MAX_FORWARDS: string;
|
---|
813 | const HTTP2_HEADER_PREFER: string;
|
---|
814 | const HTTP2_HEADER_PROXY_AUTHENTICATE: string;
|
---|
815 | const HTTP2_HEADER_PROXY_AUTHORIZATION: string;
|
---|
816 | const HTTP2_HEADER_RANGE: string;
|
---|
817 | const HTTP2_HEADER_REFERER: string;
|
---|
818 | const HTTP2_HEADER_REFRESH: string;
|
---|
819 | const HTTP2_HEADER_RETRY_AFTER: string;
|
---|
820 | const HTTP2_HEADER_SERVER: string;
|
---|
821 | const HTTP2_HEADER_SET_COOKIE: string;
|
---|
822 | const HTTP2_HEADER_STRICT_TRANSPORT_SECURITY: string;
|
---|
823 | const HTTP2_HEADER_TRANSFER_ENCODING: string;
|
---|
824 | const HTTP2_HEADER_TE: string;
|
---|
825 | const HTTP2_HEADER_UPGRADE: string;
|
---|
826 | const HTTP2_HEADER_USER_AGENT: string;
|
---|
827 | const HTTP2_HEADER_VARY: string;
|
---|
828 | const HTTP2_HEADER_VIA: string;
|
---|
829 | const HTTP2_HEADER_WWW_AUTHENTICATE: string;
|
---|
830 | const HTTP2_HEADER_HTTP2_SETTINGS: string;
|
---|
831 | const HTTP2_HEADER_KEEP_ALIVE: string;
|
---|
832 | const HTTP2_HEADER_PROXY_CONNECTION: string;
|
---|
833 | const HTTP2_METHOD_ACL: string;
|
---|
834 | const HTTP2_METHOD_BASELINE_CONTROL: string;
|
---|
835 | const HTTP2_METHOD_BIND: string;
|
---|
836 | const HTTP2_METHOD_CHECKIN: string;
|
---|
837 | const HTTP2_METHOD_CHECKOUT: string;
|
---|
838 | const HTTP2_METHOD_CONNECT: string;
|
---|
839 | const HTTP2_METHOD_COPY: string;
|
---|
840 | const HTTP2_METHOD_DELETE: string;
|
---|
841 | const HTTP2_METHOD_GET: string;
|
---|
842 | const HTTP2_METHOD_HEAD: string;
|
---|
843 | const HTTP2_METHOD_LABEL: string;
|
---|
844 | const HTTP2_METHOD_LINK: string;
|
---|
845 | const HTTP2_METHOD_LOCK: string;
|
---|
846 | const HTTP2_METHOD_MERGE: string;
|
---|
847 | const HTTP2_METHOD_MKACTIVITY: string;
|
---|
848 | const HTTP2_METHOD_MKCALENDAR: string;
|
---|
849 | const HTTP2_METHOD_MKCOL: string;
|
---|
850 | const HTTP2_METHOD_MKREDIRECTREF: string;
|
---|
851 | const HTTP2_METHOD_MKWORKSPACE: string;
|
---|
852 | const HTTP2_METHOD_MOVE: string;
|
---|
853 | const HTTP2_METHOD_OPTIONS: string;
|
---|
854 | const HTTP2_METHOD_ORDERPATCH: string;
|
---|
855 | const HTTP2_METHOD_PATCH: string;
|
---|
856 | const HTTP2_METHOD_POST: string;
|
---|
857 | const HTTP2_METHOD_PRI: string;
|
---|
858 | const HTTP2_METHOD_PROPFIND: string;
|
---|
859 | const HTTP2_METHOD_PROPPATCH: string;
|
---|
860 | const HTTP2_METHOD_PUT: string;
|
---|
861 | const HTTP2_METHOD_REBIND: string;
|
---|
862 | const HTTP2_METHOD_REPORT: string;
|
---|
863 | const HTTP2_METHOD_SEARCH: string;
|
---|
864 | const HTTP2_METHOD_TRACE: string;
|
---|
865 | const HTTP2_METHOD_UNBIND: string;
|
---|
866 | const HTTP2_METHOD_UNCHECKOUT: string;
|
---|
867 | const HTTP2_METHOD_UNLINK: string;
|
---|
868 | const HTTP2_METHOD_UNLOCK: string;
|
---|
869 | const HTTP2_METHOD_UPDATE: string;
|
---|
870 | const HTTP2_METHOD_UPDATEREDIRECTREF: string;
|
---|
871 | const HTTP2_METHOD_VERSION_CONTROL: string;
|
---|
872 | const HTTP_STATUS_CONTINUE: number;
|
---|
873 | const HTTP_STATUS_SWITCHING_PROTOCOLS: number;
|
---|
874 | const HTTP_STATUS_PROCESSING: number;
|
---|
875 | const HTTP_STATUS_OK: number;
|
---|
876 | const HTTP_STATUS_CREATED: number;
|
---|
877 | const HTTP_STATUS_ACCEPTED: number;
|
---|
878 | const HTTP_STATUS_NON_AUTHORITATIVE_INFORMATION: number;
|
---|
879 | const HTTP_STATUS_NO_CONTENT: number;
|
---|
880 | const HTTP_STATUS_RESET_CONTENT: number;
|
---|
881 | const HTTP_STATUS_PARTIAL_CONTENT: number;
|
---|
882 | const HTTP_STATUS_MULTI_STATUS: number;
|
---|
883 | const HTTP_STATUS_ALREADY_REPORTED: number;
|
---|
884 | const HTTP_STATUS_IM_USED: number;
|
---|
885 | const HTTP_STATUS_MULTIPLE_CHOICES: number;
|
---|
886 | const HTTP_STATUS_MOVED_PERMANENTLY: number;
|
---|
887 | const HTTP_STATUS_FOUND: number;
|
---|
888 | const HTTP_STATUS_SEE_OTHER: number;
|
---|
889 | const HTTP_STATUS_NOT_MODIFIED: number;
|
---|
890 | const HTTP_STATUS_USE_PROXY: number;
|
---|
891 | const HTTP_STATUS_TEMPORARY_REDIRECT: number;
|
---|
892 | const HTTP_STATUS_PERMANENT_REDIRECT: number;
|
---|
893 | const HTTP_STATUS_BAD_REQUEST: number;
|
---|
894 | const HTTP_STATUS_UNAUTHORIZED: number;
|
---|
895 | const HTTP_STATUS_PAYMENT_REQUIRED: number;
|
---|
896 | const HTTP_STATUS_FORBIDDEN: number;
|
---|
897 | const HTTP_STATUS_NOT_FOUND: number;
|
---|
898 | const HTTP_STATUS_METHOD_NOT_ALLOWED: number;
|
---|
899 | const HTTP_STATUS_NOT_ACCEPTABLE: number;
|
---|
900 | const HTTP_STATUS_PROXY_AUTHENTICATION_REQUIRED: number;
|
---|
901 | const HTTP_STATUS_REQUEST_TIMEOUT: number;
|
---|
902 | const HTTP_STATUS_CONFLICT: number;
|
---|
903 | const HTTP_STATUS_GONE: number;
|
---|
904 | const HTTP_STATUS_LENGTH_REQUIRED: number;
|
---|
905 | const HTTP_STATUS_PRECONDITION_FAILED: number;
|
---|
906 | const HTTP_STATUS_PAYLOAD_TOO_LARGE: number;
|
---|
907 | const HTTP_STATUS_URI_TOO_LONG: number;
|
---|
908 | const HTTP_STATUS_UNSUPPORTED_MEDIA_TYPE: number;
|
---|
909 | const HTTP_STATUS_RANGE_NOT_SATISFIABLE: number;
|
---|
910 | const HTTP_STATUS_EXPECTATION_FAILED: number;
|
---|
911 | const HTTP_STATUS_TEAPOT: number;
|
---|
912 | const HTTP_STATUS_MISDIRECTED_REQUEST: number;
|
---|
913 | const HTTP_STATUS_UNPROCESSABLE_ENTITY: number;
|
---|
914 | const HTTP_STATUS_LOCKED: number;
|
---|
915 | const HTTP_STATUS_FAILED_DEPENDENCY: number;
|
---|
916 | const HTTP_STATUS_UNORDERED_COLLECTION: number;
|
---|
917 | const HTTP_STATUS_UPGRADE_REQUIRED: number;
|
---|
918 | const HTTP_STATUS_PRECONDITION_REQUIRED: number;
|
---|
919 | const HTTP_STATUS_TOO_MANY_REQUESTS: number;
|
---|
920 | const HTTP_STATUS_REQUEST_HEADER_FIELDS_TOO_LARGE: number;
|
---|
921 | const HTTP_STATUS_UNAVAILABLE_FOR_LEGAL_REASONS: number;
|
---|
922 | const HTTP_STATUS_INTERNAL_SERVER_ERROR: number;
|
---|
923 | const HTTP_STATUS_NOT_IMPLEMENTED: number;
|
---|
924 | const HTTP_STATUS_BAD_GATEWAY: number;
|
---|
925 | const HTTP_STATUS_SERVICE_UNAVAILABLE: number;
|
---|
926 | const HTTP_STATUS_GATEWAY_TIMEOUT: number;
|
---|
927 | const HTTP_STATUS_HTTP_VERSION_NOT_SUPPORTED: number;
|
---|
928 | const HTTP_STATUS_VARIANT_ALSO_NEGOTIATES: number;
|
---|
929 | const HTTP_STATUS_INSUFFICIENT_STORAGE: number;
|
---|
930 | const HTTP_STATUS_LOOP_DETECTED: number;
|
---|
931 | const HTTP_STATUS_BANDWIDTH_LIMIT_EXCEEDED: number;
|
---|
932 | const HTTP_STATUS_NOT_EXTENDED: number;
|
---|
933 | const HTTP_STATUS_NETWORK_AUTHENTICATION_REQUIRED: number;
|
---|
934 | }
|
---|
935 |
|
---|
936 | export function getDefaultSettings(): Settings;
|
---|
937 | export function getPackedSettings(settings: Settings): Buffer;
|
---|
938 | export function getUnpackedSettings(buf: Uint8Array): Settings;
|
---|
939 |
|
---|
940 | export function createServer(onRequestHandler?: (request: Http2ServerRequest, response: Http2ServerResponse) => void): Http2Server;
|
---|
941 | export function createServer(options: ServerOptions, onRequestHandler?: (request: Http2ServerRequest, response: Http2ServerResponse) => void): Http2Server;
|
---|
942 |
|
---|
943 | export function createSecureServer(onRequestHandler?: (request: Http2ServerRequest, response: Http2ServerResponse) => void): Http2SecureServer;
|
---|
944 | export function createSecureServer(options: SecureServerOptions, onRequestHandler?: (request: Http2ServerRequest, response: Http2ServerResponse) => void): Http2SecureServer;
|
---|
945 |
|
---|
946 | export function connect(authority: string | url.URL, listener: (session: ClientHttp2Session, socket: net.Socket | tls.TLSSocket) => void): ClientHttp2Session;
|
---|
947 | export function connect(
|
---|
948 | authority: string | url.URL,
|
---|
949 | options?: ClientSessionOptions | SecureClientSessionOptions,
|
---|
950 | listener?: (session: ClientHttp2Session, socket: net.Socket | tls.TLSSocket) => void
|
---|
951 | ): ClientHttp2Session;
|
---|
952 | }
|
---|