Skip to content

Commit 1c9a2da

Browse files
committed
docs: update copy
--- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: passed - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed ---
1 parent d02db19 commit 1c9a2da

File tree

1 file changed

+9
-4
lines changed
  • lib/node_modules/@stdlib/net/disposable-http-server

1 file changed

+9
-4
lines changed

lib/node_modules/@stdlib/net/disposable-http-server/README.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -47,15 +47,20 @@ var opts = {
4747
httpServer( opts );
4848
```
4949

50+
The function supports the following parameters:
51+
52+
- **options**: function options.
53+
- **clbk**: callback to invoke upon creating a server (_optional_).
54+
5055
The function accepts the following options:
5156

52-
- **html**: `buffer` or `string` to serve as HTML content.
53-
- **javascript**: `buffer` or `string` to serve as JavaScript.
57+
- **html**: Buffer or string to serve as HTML content.
58+
- **javascript**: Buffer or string to serve as JavaScript.
5459
- **port**: server port. Default: `0` (i.e., randomly assigned).
5560
- **maxport**: max server port (used when port hunting). Default: `=port`.
5661
- **hostname**: server hostname.
5762
- **address**: server address. Default: `"0.0.0.0"`.
58-
- **open**: `boolean` indicating whether to launch a web browser. Default: `false`.
63+
- **open**: boolean indicating whether to launch a web browser. Default: `false`.
5964

6065
To serve HTML content, set the `html` option. Once the content is requested, the server will close.
6166

@@ -127,7 +132,7 @@ httpServer( opts, onReady );
127132

128133
## Notes
129134

130-
- If neither the `html` or `javascript` option is set, the server serves an HTML boilerplate and then closes.
135+
- If neither the `html` nor `javascript` option is set, the server serves an HTML boilerplate and then closes.
131136

132137
</section>
133138

0 commit comments

Comments
 (0)