Merge pull request #4 from ssowonny/error-documentation

Add documentation for errors
DaPulse · Apr 11, 2017 · 7b646f8 · 7b646f8
2 parents dba661e + 711d0f9
commit 7b646f8
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -109,6 +109,18 @@ params.require('contacts').permit('type', 'value').value()
 // -> [{ type: 'e-mail', value: '[email protected]' }, { type: 'mobile', value: '+123987456' }]
 ```
 
+### Errors
+
+```js
+// ParameterMissingError
+try {
+  params.require('missingKey')
+} catch(err) {
+  err instanceof ParameterMissingError // -> true
+  err instanceof Error // -> true
+}
+```
+
 Look [Rails Strong Parameters specification](http://edgeguides.rubyonrails.org/action_controller_overview.html#strong-parameters) for more information.
 
 ## Contributing