docs
This commit is contained in:
30
doc/api.md
Normal file
30
doc/api.md
Normal file
@ -0,0 +1,30 @@
|
||||
## API Reference
|
||||
|
||||
|
||||
* [local-web-server](#module_local-web-server)
|
||||
* [LocalWebServer](#exp_module_local-web-server--LocalWebServer) ⇐ <code>[middleware-stack](#module_middleware-stack)</code> ⏏
|
||||
* _instance_
|
||||
* [.add(middleware)](#) ↩︎
|
||||
* _inner_
|
||||
* [~collectUserOptions()](#module_local-web-server--LocalWebServer..collectUserOptions)
|
||||
|
||||
<a name="exp_module_local-web-server--LocalWebServer"></a>
|
||||
|
||||
### LocalWebServer ⇐ <code>[middleware-stack](#module_middleware-stack)</code> ⏏
|
||||
**Kind**: Exported class
|
||||
**Extends:** <code>[middleware-stack](#module_middleware-stack)</code>
|
||||
<a name=""></a>
|
||||
|
||||
#### localWebServer.add(middleware) ↩︎
|
||||
**Kind**: instance method of <code>[LocalWebServer](#exp_module_local-web-server--LocalWebServer)</code>
|
||||
**Chainable**
|
||||
**Params**
|
||||
|
||||
- middleware <code>[middleware](#module_middleware-stack--MiddlewareStack..middleware)</code>
|
||||
|
||||
<a name="module_local-web-server--LocalWebServer..collectUserOptions"></a>
|
||||
|
||||
#### LocalWebServer~collectUserOptions()
|
||||
Return default, stored and command-line options combined
|
||||
|
||||
**Kind**: inner method of <code>[LocalWebServer](#exp_module_local-web-server--LocalWebServer)</code>
|
Reference in New Issue
Block a user