Permalink
Browse files

docs: add mention of err.headers

closes #27
  • Loading branch information...
1 parent 1df3c34 commit d6cb13bc12c10f020d0ff5a6ec73fdf96cf6c8b7 @dougwilson dougwilson committed Nov 17, 2016
Showing with 5 additions and 1 deletion.
  1. +5 −1 README.md
View
@@ -39,7 +39,11 @@ All errors inherit from JavaScript `Error` and the exported `createError.HttpErr
### Error Properties
-- `expose` - can be used to signal if `message` should be sent to the client, defaulting to `false` when `status` >= 500
+- `expose` - can be used to signal if `message` should be sent to the client,
+ defaulting to `false` when `status` >= 500
+- `headers` - can be an object of header names to values to be sent to the
+ client, defaulting to `undefined`. When defined, the key names should all
+ be lower-cased
- `message`
- `status` and `statusCode` - the status code of the error, defaulting to `500`

0 comments on commit d6cb13b

Please sign in to comment.