Skip to content

Commit

Permalink
docs(server): update createServer JSDoc (#1634)
Browse files Browse the repository at this point in the history
  • Loading branch information
hekike committed Apr 2, 2018
1 parent a914bf6 commit dc7336b
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 4 deletions.
6 changes: 4 additions & 2 deletions docs/_api/server.md
Expand Up @@ -71,8 +71,10 @@ routes and handlers for incoming requests.
If provided the following restify server options will be ignored:
spdy, ca, certificate, key, passphrase, rejectUnauthorized, requestCert and
ciphers; however these can all be specified on httpsServerOptions.
- `options.strictRouting` **[Boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** If set, Restify
will treat "/foo" and "/foo/" as different paths. (optional, default `false`)
- `options.onceNext` **[Boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** Prevents calling next multiple
times (optional, default `false`)
- `options.strictNext` **[Boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** Throws error when next() is
called more than once, enabled onceNext option (optional, default `false`)
- `options.ignoreTrailingSlash` **[Boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** ignore trailing slash
on paths (optional, default `false`)

Expand Down
6 changes: 4 additions & 2 deletions lib/index.js
Expand Up @@ -53,8 +53,10 @@ require('./errorTypes');
* If provided the following restify server options will be ignored:
* spdy, ca, certificate, key, passphrase, rejectUnauthorized, requestCert and
* ciphers; however these can all be specified on httpsServerOptions.
* @param {Boolean} [options.strictRouting=false] - If set, Restify
* will treat "/foo" and "/foo/" as different paths.
* @param {Boolean} [options.onceNext=false] - Prevents calling next multiple
* times
* @param {Boolean} [options.strictNext=false] - Throws error when next() is
* called more than once, enabled onceNext option
* @param {Boolean} [options.ignoreTrailingSlash=false] - ignore trailing slash
* on paths
* @example
Expand Down

0 comments on commit dc7336b

Please sign in to comment.