-
-
Notifications
You must be signed in to change notification settings - Fork 400
/
index.d.ts
162 lines (143 loc) · 3.55 KB
/
index.d.ts
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
/*
* @license Apache-2.0
*
* Copyright (c) 2021 The Stdlib Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// TypeScript Version: 2.0
/**
* Interface defining function options.
*/
interface Options {
/**
* Server port (default: 0).
*/
port?: number;
/**
* Max server port.
*/
maxport?: number;
/**
* Server hostname.
*/
hostname?: string;
/**
* Server address (default: '127.0.0.1').
*/
address?: string;
}
/**
* Request callback.
*/
type NullaryListener = () => void;
/**
* Request callback.
*
* @param request - request object
*/
type UnaryListener = ( request: any ) => void;
/**
* Request callback.
*
* @param request - request object
* @param response - response object
*/
type BinaryListener = ( request: any, response: any ) => void;
/**
* Request callback.
*
* @param request - request object
* @param response - response object
*/
type RequestListener = NullaryListener | UnaryListener | BinaryListener;
/**
* Callback invoked after creating a server.
*/
type Nullary = () => void;
/**
* Callback invoked after creating a server.
*
* @param error - error object or null
*/
type Unary = ( error: Error | null ) => void;
/**
* Callback invoked after creating a server.
*
* @param error - error object or null
* @param server - server object
*/
type Binary = ( error: Error | null, server: any ) => void;
/**
* Callback invoked after creating a server.
*
* @param error - error object or null
* @param server - server object
*/
type Callback = Nullary | Unary | Binary;
/**
* Creates an HTTP server.
*
* @param done - callback to invoke after creating the server
*/
type createServer = ( done: Callback ) => void;
/**
* Returns a function which creates an HTTP server.
*
* @param requestListener - callback invoked upon receiving an HTTP request
* @returns function which creates an HTTP server
*
* @example
* var createServer = httpServer();
*
* @example
* function onRequest( request, response ) {
* console.log( request.url );
* response.end( 'OK' );
* }
* var createServer = httpServer( onRequest );
*/
declare function httpServer( requestListener?: RequestListener ): createServer;
/**
* Returns a function which creates an HTTP server.
*
* @param options - server options
* @param options.port - server port (default: 0)
* @param options.maxport - max server port
* @param options.hostname - server hostname
* @param options.address - server address (default: '127.0.0.1')
* @param requestListener - callback invoked upon receiving an HTTP request
* @throws must provide valid options
* @returns function which creates an HTTP server
*
* @example
* var opts = {
* 'port': 7331,
* 'address': '0.0.0.0'
* };
* var createServer = httpServer( opts );
*
* @example
* var opts = {
* 'port': 7331,
* 'address': '0.0.0.0'
* };
* function onRequest( request, response ) {
* console.log( request.url );
* response.end( 'OK' );
* }
* var createServer = httpServer( opts, onRequest );
*/
declare function httpServer( options: Options, requestListener?: RequestListener ): createServer; // tslint-disable-line max-line-length
// EXPORTS //
export = httpServer;