Skip to content

Commit

Permalink
Added HTTP code 423 Locked (#112)
Browse files Browse the repository at this point in the history
  • Loading branch information
Jason Maurer authored and arb committed May 20, 2016
1 parent 47f4e48 commit c3b3c6b
Show file tree
Hide file tree
Showing 3 changed files with 42 additions and 0 deletions.
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -508,6 +508,26 @@ Generates the following response payload:
}
```

### `Boom.locked([message], [data])`

Returns a 423 Locked error where:
- `message` - optional message.
- `data` - optional additional error data.

```js
Boom.locked('this resource has been locked');
```

Generates the following response payload:

```json
{
"statusCode": 423,
"error": "Locked",
"message": "this resource has been locked"
}
```

### `Boom.preconditionRequired([message], [data])`

Returns a 428 Precondition Required error where:
Expand Down
6 changes: 6 additions & 0 deletions lib/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -316,6 +316,12 @@ exports.badData = function (message, data) {
};


exports.locked = function (message, data) {

return internals.create(423, message, data, exports.locked);
};


exports.preconditionRequired = function (message, data) {

return internals.create(428, message, data, exports.preconditionRequired);
Expand Down
16 changes: 16 additions & 0 deletions test/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -463,6 +463,22 @@ describe('badData()', () => {
});


describe('locked()', () => {

it('returns a 423 error statusCode', (done) => {

expect(Boom.locked().output.statusCode).to.equal(423);
done();
});

it('sets the message with the passed in message', (done) => {

expect(Boom.locked('my message').message).to.equal('my message');
done();
});
});


describe('preconditionRequired()', () => {

it('returns a 428 error statusCode', (done) => {
Expand Down

0 comments on commit c3b3c6b

Please sign in to comment.