wpstudio/hiring-test-one
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

update docs

Browse Source
This commit is contained in:
Lloyd Brookes
2016-03-10 10:58:52 +00:00
parent a279b6ace6
commit 4ddfdf2843
3 changed files with 27 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
LICENSE
View File

@ -1,6 +1,6 @@
The MIT License (MIT) The MIT License (MIT)
Copyright (c) 2015 Lloyd Brookes <75pound@gmail.com> Copyright (c) 2013-16 Lloyd Brookes <75pound@gmail.com>
Permission is hereby granted, free of charge, to any person obtaining a copy Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal of this software and associated documentation files (the "Software"), to deal

40
README.md
View File

@ -444,6 +444,9 @@ Chrome and Firefox will still complain your certificate has not been verified by
Now you have a valid, trusted certificate for development. Now you have a valid, trusted certificate for development.
#### Built-in certificate
As a quick win, you can run `ws` with the `https` flag. This will launch an HTTPS server using a [built-in certificate](https://github.com/75lb/local-web-server/tree/master/ssl) registered to the domain 127.0.0.1.
### Stored config ### Stored config
Use the same options every time? Persist then to `package.json`: Use the same options every time? Persist then to `package.json`:
@ -582,8 +585,8 @@ serving at http://localhost:8100
* [local-web-server](#module_local-web-server) * [local-web-server](#module_local-web-server)
* [localWebServer([options])](#exp_module_local-web-server--localWebServer) ⇒ <code>[KoaApplication](https://github.com/koajs/koa/blob/master/docs/api/index.md#application)</code> ⏏ * [localWebServer([options])](#exp_module_local-web-server--localWebServer) ⇒ <code>[KoaApplication](https://github.com/koajs/koa/blob/master/docs/api/index.md#application)</code> ⏏
* [~rewriteRule](#module_local-web-server--localWebServer..rewriteRule) * [~rewriteRule](#module_local-web-server--localWebServer..rewriteRule)
<a name="exp_module_local-web-server--localWebServer"></a> <a name="exp_module_local-web-server--localWebServer"></a>
### localWebServer([options]) ⇒ <code>[KoaApplication](https://github.com/koajs/koa/blob/master/docs/api/index.md#application)</code> ⏏ ### localWebServer([options]) ⇒ <code>[KoaApplication](https://github.com/koajs/koa/blob/master/docs/api/index.md#application)</code> ⏏
@ -591,22 +594,23 @@ Returns a Koa application you can launch or mix into an existing app.
**Kind**: Exported function **Kind**: Exported function
**Params** **Params**
- [options] <code>object</code> - options - [options] <code>object</code> - options
- [.static] <code>object</code> - koa-static config - [.static] <code>object</code> - koa-static config
- [.root] <code>string</code> <code> = &quot;.&quot;</code> - root directory - [.root] <code>string</code> <code> = &quot;.&quot;</code> - root directory
- [.options] <code>string</code> - [options](https://github.com/koajs/static#options) - [.options] <code>string</code> - [options](https://github.com/koajs/static#options)
- [.serveIndex] <code>object</code> - koa-serve-index config - [.serveIndex] <code>object</code> - koa-serve-index config
- [.path] <code>string</code> <code> = &quot;.&quot;</code> - root directory - [.path] <code>string</code> <code> = &quot;.&quot;</code> - root directory
- [.options] <code>string</code> - [options](https://github.com/expressjs/serve-index#options) - [.options] <code>string</code> - [options](https://github.com/expressjs/serve-index#options)
- [.forbid] <code>Array.&lt;string&gt;</code> - A list of forbidden routes, each route being an [express route-path](http://expressjs.com/guide/routing.html#route-paths). - [.forbid] <code>Array.&lt;string&gt;</code> - A list of forbidden routes, each route being an [express route-path](http://expressjs.com/guide/routing.html#route-paths).
- [.spa] <code>string</code> - specify an SPA file to catch requests for everything but static assets. - [.spa] <code>string</code> - specify an SPA file to catch requests for everything but static assets.
- [.log] <code>object</code> - [morgan](https://github.com/expressjs/morgan) config - [.log] <code>object</code> - [morgan](https://github.com/expressjs/morgan) config
- [.format] <code>string</code> - [log format](https://github.com/expressjs/morgan#predefined-formats) - [.format] <code>string</code> - [log format](https://github.com/expressjs/morgan#predefined-formats)
- [.options] <code>object</code> - [options](https://github.com/expressjs/morgan#options) - [.options] <code>object</code> - [options](https://github.com/expressjs/morgan#options)
- [.compress] <code>boolean</code> - Serve gzip-compressed resources, where applicable - [.compress] <code>boolean</code> - Serve gzip-compressed resources, where applicable
- [.mime] <code>object</code> - A list of mime-type overrides, passed directly to [mime.define()](https://github.com/broofa/node-mime#mimedefine) - [.mime] <code>object</code> - A list of mime-type overrides, passed directly to [mime.define()](https://github.com/broofa/node-mime#mimedefine)
- [.rewrite] <code>[Array.&lt;rewriteRule&gt;](#module_local-web-server--localWebServer..rewriteRule)</code> - One or more rewrite rules - [.rewrite] <code>[Array.&lt;rewriteRule&gt;](#module_local-web-server--localWebServer..rewriteRule)</code> - One or more rewrite rules
- [.verbose] <code>boolean</code> - Print detailed output, useful for debugging - [.verbose] <code>boolean</code> - Print detailed output, useful for debugging
**Example** **Example**
```js ```js
@ -638,4 +642,4 @@ The `from` and `to` routes are specified using [express route-paths](http://expr
* * * * * *
&copy; 2015 Lloyd Brookes <75pound@gmail.com>. Documented by [jsdoc-to-markdown](https://github.com/jsdoc2md/jsdoc-to-markdown). &copy; 2013-16 Lloyd Brookes <75pound@gmail.com>. Documented by [jsdoc-to-markdown](https://github.com/jsdoc2md/jsdoc-to-markdown).

5
jsdoc2md/README.hbs
View File

@ -444,6 +444,9 @@ Chrome and Firefox will still complain your certificate has not been verified by
Now you have a valid, trusted certificate for development. Now you have a valid, trusted certificate for development.
#### Built-in certificate
As a quick win, you can run `ws` with the `https` flag. This will launch an HTTPS server using a [built-in certificate](https://github.com/75lb/local-web-server/tree/master/ssl) registered to the domain 127.0.0.1.
### Stored config ### Stored config
Use the same options every time? Persist then to `package.json`: Use the same options every time? Persist then to `package.json`:
@ -589,4 +592,4 @@ serving at http://localhost:8100
* * * * * *
&copy; 2015 Lloyd Brookes <75pound@gmail.com>. Documented by [jsdoc-to-markdown](https://github.com/jsdoc2md/jsdoc-to-markdown). &copy; 2013-16 Lloyd Brookes <75pound@gmail.com>. Documented by [jsdoc-to-markdown](https://github.com/jsdoc2md/jsdoc-to-markdown).