docs: close #6

tunnckoCore · Feb 10, 2016 · ae7da05 · ae7da05
1 parent e8b5496
commit ae7da05
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -33,6 +33,8 @@ const KindError = require('kind-error')
 
 * `message` **{Object|String}**
 * `[options]` **{Object}**
+  - `showStack` **{Boolean}** if `true` [error will have `.stack` property](./test.js#L15-L36)
+  - `detailed` **{Boolean}** if `true` [more detailed `.message` will be composed](./test.js#L108-L120)
 * `returns` **{Object}**: instance of Error
 
 **Example**

diff --git a/index.js b/index.js
@@ -32,6 +32,8 @@ var delegate = require('delegate-properties')
  *
  * @param  {Object|String} `message`
  * @param  {Object} `[options]`
+ *   @option {Boolean} `showStack` if `true` [error will have `.stack` property](./test.js#L15-L36)
+ *   @option {Boolean} `detailed` if `true` [more detailed `.message` will be composed](./test.js#L108-L120)
  * @return {Object} instance of Error
  * @api public
  */