Skip to content

Commit

Permalink
Update/Clarify documentation for creating new Boom. (#267)
Browse files Browse the repository at this point in the history
  • Loading branch information
mattboutet authored May 15, 2020
1 parent 7e94679 commit b889080
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions API.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ chain which is very slow.

#### Helper Methods

##### `new Boom(message, [options])`
##### `new Boom.Boom(message, [options])`

Creates a new `Boom` object using the provided `message` and then calling
[`boomify()`](#boomifyerr-options) to decorate the error with the `Boom` properties, where:
Expand Down Expand Up @@ -69,7 +69,7 @@ Boom.boomify(error, { statusCode: 400 });

##### `isBoom(err, statusCode)`

Identifies whether an error is a `Boom` object. Same as calling `instanceof Boom`.
Identifies whether an error is a `Boom` object. Same as calling `instanceof Boom`.
- `err` - Error object.
- `statusCode` - optional status code.

Expand Down

0 comments on commit b889080

Please sign in to comment.