Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[node] Improve http2 definitions #33019

Closed
wants to merge 4 commits into from
Closed

[node] Improve http2 definitions #33019

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2ee3da3
Http2ServerRequest Stream
alessiodionisi Feb 12, 2019
d0a095f
node 10 defs
alessiodionisi Feb 13, 2019
5a027d0
private constructor
alessiodionisi Feb 13, 2019
e1f35a3
HTTP2 Tests
alessiodionisi Feb 13, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
90 changes: 25 additions & 65 deletions types/node/http2.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -528,16 +528,20 @@ declare module "http2" {

export class Http2ServerRequest extends stream.Readable {
private constructor();
headers: IncomingHttpHeaders;
httpVersion: string;
method: string;
rawHeaders: string[];
rawTrailers: string[];

readonly method: string;
readonly httpVersion: string;
readonly headers: IncomingHttpHeaders;
readonly rawHeaders: string[];
readonly rawTrailers: string[];
readonly socket: net.Socket | tls.TLSSocket;
readonly stream: ServerHttp2Stream;
readonly trailers: IncomingHttpHeaders;
readonly url: string;
readonly aborted: boolean;
readonly authority: string;

setTimeout(msecs: number, callback?: () => void): void;
socket: net.Socket | tls.TLSSocket;
stream: ServerHttp2Stream;
trailers: IncomingHttpHeaders;
url: string;

addListener(event: string, listener: (...args: any[]) => void): this;
addListener(event: "aborted", listener: (hadError: boolean, code: number) => void): this;
Expand All @@ -558,75 +562,31 @@ declare module "http2" {
prependOnceListener(event: "aborted", listener: (hadError: boolean, code: number) => void): this;
}

export class Http2ServerResponse extends events.EventEmitter {
export class Http2ServerResponse extends stream.Writable {
private constructor();
addTrailers(trailers: OutgoingHttpHeaders): void;
connection: net.Socket | tls.TLSSocket;
end(callback?: () => void): void;
end(data?: string | Buffer, callback?: () => void): void;
end(data?: string | Buffer, encoding?: string, callback?: () => void): void;

readonly finished: boolean;
readonly headersSent: boolean;
readonly connection: net.Socket | tls.TLSSocket;
readonly socket: net.Socket | tls.TLSSocket;
readonly stream: ServerHttp2Stream;
sendDate: boolean;
statusMessage: '';
statusCode: number;

addTrailers(trailers: OutgoingHttpHeaders): void;
getHeader(name: string): string;
getHeaderNames(): string[];
getHeaders(): OutgoingHttpHeaders;
hasHeader(name: string): boolean;
readonly headersSent: boolean;
removeHeader(name: string): void;
sendDate: boolean;
setHeader(name: string, value: number | string | string[]): void;
setTimeout(msecs: number, callback?: () => void): void;
socket: net.Socket | tls.TLSSocket;
statusCode: number;
statusMessage: '';
stream: ServerHttp2Stream;
write(chunk: string | Buffer, callback?: (err: Error) => void): boolean;
write(chunk: string | Buffer, encoding?: string, callback?: (err: Error) => void): boolean;
writeContinue(): void;
writeHead(statusCode: number, headers?: OutgoingHttpHeaders): void;
writeHead(statusCode: number, statusMessage?: string, headers?: OutgoingHttpHeaders): void;
createPushResponse(headers: OutgoingHttpHeaders, callback: (err: Error | null, res: Http2ServerResponse) => void): void;

addListener(event: string, listener: (...args: any[]) => void): this;
addListener(event: "aborted", listener: (hadError: boolean, code: number) => void): this;
addListener(event: "close", listener: () => void): this;
addListener(event: "drain", listener: () => void): this;
addListener(event: "error", listener: (error: Error) => void): this;
addListener(event: "finish", listener: () => void): this;

emit(event: string | symbol, ...args: any[]): boolean;
emit(event: "aborted", hadError: boolean, code: number): boolean;
emit(event: "close"): boolean;
emit(event: "drain"): boolean;
emit(event: "error", error: Error): boolean;
emit(event: "finish"): boolean;

on(event: string, listener: (...args: any[]) => void): this;
on(event: "aborted", listener: (hadError: boolean, code: number) => void): this;
on(event: "close", listener: () => void): this;
on(event: "drain", listener: () => void): this;
on(event: "error", listener: (error: Error) => void): this;
on(event: "finish", listener: () => void): this;

once(event: string, listener: (...args: any[]) => void): this;
once(event: "aborted", listener: (hadError: boolean, code: number) => void): this;
once(event: "close", listener: () => void): this;
once(event: "drain", listener: () => void): this;
once(event: "error", listener: (error: Error) => void): this;
once(event: "finish", listener: () => void): this;

prependListener(event: string, listener: (...args: any[]) => void): this;
prependListener(event: "aborted", listener: (hadError: boolean, code: number) => void): this;
prependListener(event: "close", listener: () => void): this;
prependListener(event: "drain", listener: () => void): this;
prependListener(event: "error", listener: (error: Error) => void): this;
prependListener(event: "finish", listener: () => void): this;

prependOnceListener(event: string, listener: (...args: any[]) => void): this;
prependOnceListener(event: "aborted", listener: (hadError: boolean, code: number) => void): this;
prependOnceListener(event: "close", listener: () => void): this;
prependOnceListener(event: "drain", listener: () => void): this;
prependOnceListener(event: "error", listener: (error: Error) => void): this;
prependOnceListener(event: "finish", listener: () => void): this;
flushHeaders(): void;
}

// Public API
Expand Down
1 change: 1 addition & 0 deletions types/node/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@
// Jeremie Rodriguez <https://github.com/jeremiergz>
// Samuel Ainsworth <https://github.com/samuela>
// Kyle Uehlein <https://github.com/kuehlein>
// Alessio Dionisi <https://github.com/adnsio>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped

// NOTE: These definitions support NodeJS and TypeScript 3.1.
Expand Down
8 changes: 4 additions & 4 deletions types/node/node-tests.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2813,13 +2813,13 @@ import * as constants from 'constants';
response.writeHead(200, 'OK', outgoingHeaders);
response.writeHead(200, 'OK');
response.write('');
response.write('', (err: Error) => {});
response.write('', (err: Error | null | undefined) => {});
response.write('', 'utf8');
response.write('', 'utf8', (err: Error) => {});
response.write('', 'utf8', (err: Error | null | undefined) => {});
response.write(Buffer.from([]));
response.write(Buffer.from([]), (err: Error) => {});
response.write(Buffer.from([]), (err: Error | null | undefined) => {});
response.write(Buffer.from([]), 'utf8');
response.write(Buffer.from([]), 'utf8', (err: Error) => {});
response.write(Buffer.from([]), 'utf8', (err: Error | null | undefined) => {});
response.end();
response.end(() => {});
response.end('');
Expand Down
90 changes: 25 additions & 65 deletions types/node/v10/http2.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -528,16 +528,20 @@ declare module "http2" {

export class Http2ServerRequest extends stream.Readable {
private constructor();
headers: IncomingHttpHeaders;
httpVersion: string;
method: string;
rawHeaders: string[];
rawTrailers: string[];

readonly method: string;
readonly httpVersion: string;
readonly headers: IncomingHttpHeaders;
readonly rawHeaders: string[];
readonly rawTrailers: string[];
readonly socket: net.Socket | tls.TLSSocket;
readonly stream: ServerHttp2Stream;
readonly trailers: IncomingHttpHeaders;
readonly url: string;
readonly aborted: boolean;
readonly authority: string;

setTimeout(msecs: number, callback?: () => void): void;
socket: net.Socket | tls.TLSSocket;
stream: ServerHttp2Stream;
trailers: IncomingHttpHeaders;
url: string;

addListener(event: string, listener: (...args: any[]) => void): this;
addListener(event: "aborted", listener: (hadError: boolean, code: number) => void): this;
Expand All @@ -558,75 +562,31 @@ declare module "http2" {
prependOnceListener(event: "aborted", listener: (hadError: boolean, code: number) => void): this;
}

export class Http2ServerResponse extends events.EventEmitter {
export class Http2ServerResponse extends stream.Writable {
private constructor();
addTrailers(trailers: OutgoingHttpHeaders): void;
connection: net.Socket | tls.TLSSocket;
end(callback?: () => void): void;
end(data?: string | Buffer, callback?: () => void): void;
end(data?: string | Buffer, encoding?: string, callback?: () => void): void;

readonly finished: boolean;
readonly headersSent: boolean;
readonly connection: net.Socket | tls.TLSSocket;
readonly socket: net.Socket | tls.TLSSocket;
readonly stream: ServerHttp2Stream;
sendDate: boolean;
statusMessage: '';
statusCode: number;

addTrailers(trailers: OutgoingHttpHeaders): void;
getHeader(name: string): string;
getHeaderNames(): string[];
getHeaders(): OutgoingHttpHeaders;
hasHeader(name: string): boolean;
readonly headersSent: boolean;
removeHeader(name: string): void;
sendDate: boolean;
setHeader(name: string, value: number | string | string[]): void;
setTimeout(msecs: number, callback?: () => void): void;
socket: net.Socket | tls.TLSSocket;
statusCode: number;
statusMessage: '';
stream: ServerHttp2Stream;
write(chunk: string | Buffer, callback?: (err: Error) => void): boolean;
write(chunk: string | Buffer, encoding?: string, callback?: (err: Error) => void): boolean;
writeContinue(): void;
writeHead(statusCode: number, headers?: OutgoingHttpHeaders): void;
writeHead(statusCode: number, statusMessage?: string, headers?: OutgoingHttpHeaders): void;
createPushResponse(headers: OutgoingHttpHeaders, callback: (err: Error | null, res: Http2ServerResponse) => void): void;

addListener(event: string, listener: (...args: any[]) => void): this;
addListener(event: "aborted", listener: (hadError: boolean, code: number) => void): this;
addListener(event: "close", listener: () => void): this;
addListener(event: "drain", listener: () => void): this;
addListener(event: "error", listener: (error: Error) => void): this;
addListener(event: "finish", listener: () => void): this;

emit(event: string | symbol, ...args: any[]): boolean;
emit(event: "aborted", hadError: boolean, code: number): boolean;
emit(event: "close"): boolean;
emit(event: "drain"): boolean;
emit(event: "error", error: Error): boolean;
emit(event: "finish"): boolean;

on(event: string, listener: (...args: any[]) => void): this;
on(event: "aborted", listener: (hadError: boolean, code: number) => void): this;
on(event: "close", listener: () => void): this;
on(event: "drain", listener: () => void): this;
on(event: "error", listener: (error: Error) => void): this;
on(event: "finish", listener: () => void): this;

once(event: string, listener: (...args: any[]) => void): this;
once(event: "aborted", listener: (hadError: boolean, code: number) => void): this;
once(event: "close", listener: () => void): this;
once(event: "drain", listener: () => void): this;
once(event: "error", listener: (error: Error) => void): this;
once(event: "finish", listener: () => void): this;

prependListener(event: string, listener: (...args: any[]) => void): this;
prependListener(event: "aborted", listener: (hadError: boolean, code: number) => void): this;
prependListener(event: "close", listener: () => void): this;
prependListener(event: "drain", listener: () => void): this;
prependListener(event: "error", listener: (error: Error) => void): this;
prependListener(event: "finish", listener: () => void): this;

prependOnceListener(event: string, listener: (...args: any[]) => void): this;
prependOnceListener(event: "aborted", listener: (hadError: boolean, code: number) => void): this;
prependOnceListener(event: "close", listener: () => void): this;
prependOnceListener(event: "drain", listener: () => void): this;
prependOnceListener(event: "error", listener: (error: Error) => void): this;
prependOnceListener(event: "finish", listener: () => void): this;
flushHeaders(): void;
}

// Public API
Expand Down
1 change: 1 addition & 0 deletions types/node/v10/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@
// Jeremie Rodriguez <https://github.com/jeremiergz>
// Samuel Ainsworth <https://github.com/samuela>
// Kyle Uehlein <https://github.com/kuehlein>
// Alessio Dionisi <https://github.com/adnsio>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped

// NOTE: These definitions support NodeJS and TypeScript 3.1.
Expand Down