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
|
/*
* @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: '0.0.0.0').
*/
address?: string;
/**
* Indicates whether to launch a web browser (default: false).
*/
open?: boolean;
}
/**
* 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 a simple HTTP server. The implementation takes inspiration from Python's [SimpleHTTPServer][python-simplehttpserver].
*
* [python-simplehttpserver]: https://docs.python.org/2/library/simplehttpserver.html
*
* @param clbk - callback to invoke upon creating a server
* @throws error encountered when starting server
*
* @example
* httpServer( onReady );
*
* function onReady( error, server ) {
* if ( error ) {
* throw error;
* }
* server.close();
* }
*/
declare function httpServer( clbk?: Callback ): void;
/**
* Creates a simple HTTP server. The implementation takes inspiration from Python's [SimpleHTTPServer][python-simplehttpserver].
*
* [python-simplehttpserver]: https://docs.python.org/2/library/simplehttpserver.html
*
* @param options - server options
* @param options.dir - directory from which to serve files
* @param options.port - server port (default: 0)
* @param options.maxport - max server port
* @param options.hostname - server hostname
* @param options.address - server address (default: '0.0.0.0')
* @param options.open - indicates whether to launch a web browser (default: false)
* @param clbk - callback to invoke upon creating a server
* @throws must provide valid options
* @throws error encountered when starting server
*
* @example
* var opts = {
* 'dir': './',
* 'port': 7331,
* 'hostname': 'localhost',
* 'open': false
* };
* httpServer( opts, onReady );
*
* function onReady( error, server ) {
* if ( error ) {
* throw error;
* }
* server.close();
* }
*/
declare function httpServer( options: Options, clbk?: Callback ): void;
// EXPORTS //
export = httpServer;
|
