Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Better docs for controller `error` method

  • Loading branch information...
commit 88d1eb7f4526251f7f4cdd8448af1cb7630d94ba 1 parent bc1eae9
mde authored
Showing with 3 additions and 3 deletions.
  1. +3 −3 docs/3-controllers.md
View
6 docs/3-controllers.md
@@ -144,9 +144,9 @@ this.redirect({controller: 'users', action: 'show', id: 1});
Respond to a request with an appropriate HTTP error-code. If a status-code is set on the error object, uses that as the error's status-code. Otherwise, responds with a 500 for the status-code.
-##### err
-- `statusCode [number]` the code to send to the client
-- `message [string]` the message to send to the client
+##### err [error]
+- `statusCode [number]` optional HTTP status code to send to the client, defaults to 500
+- `message [string]` the error message text to send to the client
##### examples
```
Please sign in to comment.
Something went wrong with that request. Please try again.