Skip to content

Commit 0ea224f

Browse files
blakeembreyblakeembrey
committed
Tidy up http classes
1 parent 6e4e3f0 commit 0ea224f

File tree

4 files changed

+82
-74
lines changed

4 files changed

+82
-74
lines changed

‎0.10/node.d.ts‎

Lines changed: 64 additions & 62 deletions
Original file line numberDiff line numberDiff line change
@@ -412,7 +412,7 @@ declare module "http" {
412412
[header: string]: string | string[];
413413
}
414414

415-
export interface Server extends events.EventEmitter {
415+
export class Server extends events.EventEmitter {
416416
listen(port: number, hostname?: string, backlog?: number, callback?: Function): Server;
417417
listen(path: string, callback?: Function): Server;
418418
listen(handle: any, listeningListener?: Function): Server;
@@ -421,7 +421,7 @@ declare module "http" {
421421
maxHeadersCount: number;
422422
}
423423

424-
export interface IncomingMessage extends events.EventEmitter, stream.Readable {
424+
export class IncomingMessage extends stream.Readable {
425425
httpVersion: string;
426426
headers: IncomingHeaders;
427427
rawHeaders: string[];
@@ -447,7 +447,7 @@ declare module "http" {
447447
socket: net.Socket;
448448
}
449449

450-
export interface ServerResponse extends events.EventEmitter, stream.Writable {
450+
export class ServerResponse extends stream.Writable {
451451
// Extended base methods
452452
write(buffer: Buffer): boolean;
453453
write(buffer: Buffer, cb?: Function): boolean;
@@ -460,6 +460,7 @@ declare module "http" {
460460
writeHead(statusCode: number, headers?: OutgoingHeaders): void;
461461
statusCode: number;
462462
setHeader(name: string, value: string): void;
463+
setTimeout(msecs: number, callback: () => void): this;
463464
sendDate: boolean;
464465
getHeader(name: string): string;
465466
removeHeader(name: string): void;
@@ -473,33 +474,33 @@ declare module "http" {
473474
end(str: string, encoding?: string, cb?: Function): void;
474475
}
475476

476-
/**
477-
* Object returned by http.request()
478-
*/
479-
export interface ClientRequest extends events.EventEmitter, stream.Writable {
477+
/**
478+
* Object returned by http.request()
479+
*/
480+
export class ClientRequest extends stream.Writable {
480481
abort(): void;
481482
setTimeout(timeout: number, callback?: Function): void;
482483
setNoDelay(noDelay?: boolean): void;
483484
setSocketKeepAlive(enable?: boolean, initialDelay?: number): void;
484485
}
485486

486487
export interface AgentOptions {
487-
/**
488-
* Keep sockets around in a pool to be used by other requests in the future. Default = false
489-
*/
488+
/**
489+
* Keep sockets around in a pool to be used by other requests in the future. Default = false
490+
*/
490491
keepAlive?: boolean;
491-
/**
492-
* When using HTTP KeepAlive, how often to send TCP KeepAlive packets over sockets being kept alive. Default = 1000.
493-
* Only relevant if keepAlive is set to true.
494-
*/
492+
/**
493+
* When using HTTP KeepAlive, how often to send TCP KeepAlive packets over sockets being kept alive. Default = 1000.
494+
* Only relevant if keepAlive is set to true.
495+
*/
495496
keepAliveMsecs?: number;
496-
/**
497-
* Maximum number of sockets to allow per host. Default for Node 0.10 is 5, default for Node 0.12 is Infinity
498-
*/
497+
/**
498+
* Maximum number of sockets to allow per host. Default for Node 0.10 is 5, default for Node 0.12 is Infinity
499+
*/
499500
maxSockets?: number;
500-
/**
501-
* Maximum number of sockets to leave open in a free state. Only relevant if keepAlive is set to true. Default = 256.
502-
*/
501+
/**
502+
* Maximum number of sockets to leave open in a free state. Only relevant if keepAlive is set to true. Default = 256.
503+
*/
503504
maxFreeSockets?: number;
504505
}
505506

@@ -510,68 +511,69 @@ declare module "http" {
510511

511512
constructor(opts?: AgentOptions);
512513

513-
/**
514-
* Destroy any sockets that are currently in use by the agent.
515-
* It is usually not necessary to do this. However, if you are using an agent with KeepAlive enabled,
516-
* then it is best to explicitly shut down the agent when you know that it will no longer be used. Otherwise,
517-
* sockets may hang open for quite a long time before the server terminates them.
518-
*/
514+
/**
515+
* Destroy any sockets that are currently in use by the agent.
516+
* It is usually not necessary to do this. However, if you are using an agent with KeepAlive enabled,
517+
* then it is best to explicitly shut down the agent when you know that it will no longer be used. Otherwise,
518+
* sockets may hang open for quite a long time before the server terminates them.
519+
*/
519520
destroy(): void;
520521
}
521522

522-
/**
523-
* Options for http.request()
524-
*/
523+
/**
524+
* Options for http.request()
525+
*/
525526
export interface RequestOptions {
526-
/**
527-
* A domain name or IP address of the server to issue the request to. Defaults to 'localhost'.
528-
*/
527+
/**
528+
* A domain name or IP address of the server to issue the request to. Defaults to 'localhost'.
529+
*/
529530
host?: string;
530-
/**
531-
* To support url.parse() hostname is preferred over host
532-
*/
531+
/**
532+
* To support url.parse() hostname is preferred over host
533+
*/
533534
hostname?: string;
534-
/**
535-
* Port of remote server. Defaults to 80.
536-
*/
535+
/**
536+
* Port of remote server. Defaults to 80.
537+
*/
537538
port?: number | string;
538-
/**
539-
* Local interface to bind for network connections.
540-
*/
539+
/**
540+
* Local interface to bind for network connections.
541+
*/
541542
localAddress?: string;
542-
/**
543-
* Unix Domain Socket (use one of host:port or socketPath)
544-
*/
543+
/**
544+
* Unix Domain Socket (use one of host:port or socketPath)
545+
*/
545546
socketPath?: string;
546-
/**
547-
* A string specifying the HTTP request method. Defaults to 'GET'.
548-
*/
547+
/**
548+
* A string specifying the HTTP request method. Defaults to 'GET'.
549+
*/
549550
method?: string;
550-
/**
551-
* Request path. Defaults to '/'. Should include query string if any. E.G. '/index.html?page=12'
552-
*/
551+
/**
552+
* Request path. Defaults to '/'. Should include query string if any. E.G. '/index.html?page=12'
553+
*/
553554
path?: string;
554-
/**
555-
* An object containing request headers.
556-
*/
555+
/**
556+
* An object containing request headers.
557+
*/
557558
headers?: OutgoingHeaders;
558-
/**
559-
* Basic authentication i.e. 'user:password' to compute an Authorization header.
560-
*/
559+
/**
560+
* Basic authentication i.e. 'user:password' to compute an Authorization header.
561+
*/
561562
auth?: string;
562-
/**
563-
* Controls Agent behavior. When an Agent is used request will default to Connection: keep-alive. Possible values:
564-
* - undefined (default): use global Agent for this host and port.
565-
* - Agent object: explicitly use the passed in Agent.
566-
* - false: opts out of connection pooling with an Agent, defaults request to Connection: close.
567-
*/
563+
/**
564+
* Controls Agent behavior. When an Agent is used request will default to Connection: keep-alive. Possible values:
565+
* - undefined (default): use global Agent for this host and port.
566+
* - Agent object: explicitly use the passed in Agent.
567+
* - false: opts out of connection pooling with an Agent, defaults request to Connection: close.
568+
*/
568569
agent?: Agent | boolean;
569570
}
570571

571572
export var STATUS_CODES: {
572573
[errorCode: number]: string;
573574
[errorCode: string]: string;
574575
};
576+
575577
export function createServer(requestListener?: (request: IncomingMessage, response: ServerResponse) => void): Server;
576578
export function createClient(port?: number, host?: string): any;
577579
export function request(options: string | RequestOptions, callback?: (response: IncomingMessage) => void): ClientRequest;

‎0.12/node.d.ts‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -599,7 +599,7 @@ declare module "http" {
599599
agent?: Agent | boolean;
600600
}
601601

602-
export interface Server extends events.EventEmitter {
602+
export class Server extends events.EventEmitter {
603603
listen(port: number, hostname?: string, backlog?: number, callback?: Function): Server;
604604
listen(port: number, hostname?: string, callback?: Function): Server;
605605
listen(path: string, callback?: Function): Server;
@@ -609,7 +609,7 @@ declare module "http" {
609609
maxHeadersCount: number;
610610
}
611611

612-
export interface ServerResponse extends events.EventEmitter, stream.Writable {
612+
export class ServerResponse extends stream.Writable {
613613
// Extended base methods
614614
write(buffer: Buffer): boolean;
615615
write(buffer: Buffer, cb?: Function): boolean;
@@ -623,6 +623,7 @@ declare module "http" {
623623
statusCode: number;
624624
statusMessage: string;
625625
setHeader(name: string, value: string): void;
626+
setTimeout(msecs: number, callback: () => void): this;
626627
sendDate: boolean;
627628
getHeader(name: string): string;
628629
removeHeader(name: string): void;
@@ -636,7 +637,7 @@ declare module "http" {
636637
end(str: string, encoding?: string, cb?: Function): void;
637638
}
638639

639-
export interface ClientRequest extends events.EventEmitter, stream.Writable {
640+
export class ClientRequest extends stream.Writable {
640641
// Extended base methods
641642
write(buffer: Buffer): boolean;
642643
write(buffer: Buffer, cb?: Function): boolean;
@@ -658,7 +659,7 @@ declare module "http" {
658659
end(data?: any, encoding?: string): void;
659660
}
660661

661-
export interface IncomingMessage extends events.EventEmitter, stream.Readable {
662+
export class IncomingMessage extends stream.Readable {
662663
httpVersion: string;
663664
headers: IncomingHeaders;
664665
rawHeaders: string[];
@@ -726,6 +727,7 @@ declare module "http" {
726727
[errorCode: number]: string;
727728
[errorCode: string]: string;
728729
};
730+
729731
export function createServer(requestListener?: (request: IncomingMessage, response: ServerResponse) => void): Server;
730732
export function createClient(port?: number, host?: string): any;
731733
export function request(options: string | RequestOptions, callback?: (res: IncomingMessage) => void): ClientRequest;

‎4.0/node.d.ts‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -722,13 +722,13 @@ declare module "http" {
722722
agent?: Agent | boolean;
723723
}
724724

725-
export interface Server extends events.EventEmitter, net.Server {
725+
export class Server extends net.Server {
726726
setTimeout(msecs: number, callback: Function): void;
727727
maxHeadersCount: number;
728728
timeout: number;
729729
}
730730

731-
export interface ServerResponse extends events.EventEmitter, stream.Writable {
731+
export class ServerResponse extends stream.Writable {
732732
// Extended base methods
733733
write(buffer: Buffer): boolean;
734734
write(buffer: Buffer, cb?: Function): boolean;
@@ -743,6 +743,7 @@ declare module "http" {
743743
statusMessage: string;
744744
headersSent: boolean;
745745
setHeader(name: string, value: string | string[]): void;
746+
setTimeout(msecs: number, callback: () => void): this;
746747
sendDate: boolean;
747748
getHeader(name: string): string;
748749
removeHeader(name: string): void;
@@ -756,7 +757,7 @@ declare module "http" {
756757
end(str: string, encoding?: string, cb?: Function): void;
757758
}
758759

759-
export interface ClientRequest extends events.EventEmitter, stream.Writable {
760+
export class ClientRequest extends stream.Writable {
760761
// Extended base methods
761762
write(buffer: Buffer): boolean;
762763
write(buffer: Buffer, cb?: Function): boolean;
@@ -783,7 +784,7 @@ declare module "http" {
783784
end(data?: any, encoding?: string): void;
784785
}
785786

786-
export interface IncomingMessage extends events.EventEmitter, stream.Readable {
787+
export class IncomingMessage extends stream.Readable {
787788
httpVersion: string;
788789
httpVersionMajor: number;
789790
httpVersionMinor: number;
@@ -853,6 +854,7 @@ declare module "http" {
853854
[errorCode: number]: string;
854855
[errorCode: string]: string;
855856
};
857+
856858
export function createServer(requestListener?: (request: IncomingMessage, response: ServerResponse) => void): Server;
857859
export function createClient(port?: number, host?: string): any;
858860
export function request(options: string | RequestOptions, callback?: (res: IncomingMessage) => void): ClientRequest;

‎6.0/node.d.ts‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -754,14 +754,14 @@ declare module "http" {
754754
agent?: Agent | boolean;
755755
}
756756

757-
export interface Server extends events.EventEmitter, net.Server {
757+
export class Server extends net.Server {
758758
setTimeout(msecs: number, callback: Function): void;
759759
maxHeadersCount: number;
760760
timeout: number;
761761
listening: boolean;
762762
}
763763

764-
export interface ServerResponse extends events.EventEmitter, stream.Writable {
764+
export class ServerResponse extends stream.Writable {
765765
// Extended base methods
766766
write(buffer: Buffer): boolean;
767767
write(buffer: Buffer, cb?: Function): boolean;
@@ -776,6 +776,7 @@ declare module "http" {
776776
statusMessage: string;
777777
headersSent: boolean;
778778
setHeader(name: string, value: string | string[]): void;
779+
setTimeout(msecs: number, callback: () => void): this;
779780
sendDate: boolean;
780781
getHeader(name: string): string;
781782
removeHeader(name: string): void;
@@ -789,7 +790,7 @@ declare module "http" {
789790
end(str: string, encoding?: string, cb?: Function): void;
790791
}
791792

792-
export interface ClientRequest extends events.EventEmitter, stream.Writable {
793+
export class ClientRequest extends stream.Writable {
793794
// Extended base methods
794795
write(buffer: Buffer): boolean;
795796
write(buffer: Buffer, cb?: Function): boolean;
@@ -816,7 +817,7 @@ declare module "http" {
816817
end(data?: any, encoding?: string): void;
817818
}
818819

819-
export interface IncomingMessage extends events.EventEmitter, stream.Readable {
820+
export class IncomingMessage extends stream.Readable {
820821
httpVersion: string;
821822
headers: IncomingHeaders;
822823
rawHeaders: string[];
@@ -884,6 +885,7 @@ declare module "http" {
884885
[errorCode: number]: string;
885886
[errorCode: string]: string;
886887
};
888+
887889
export function createServer(requestListener?: (request: IncomingMessage, response: ServerResponse) => void): Server;
888890
export function createClient(port?: number, host?: string): any;
889891
export function request(options: string | RequestOptions, callback?: (res: IncomingMessage) => void): ClientRequest;

0 commit comments

Comments
 (0)