mirror of
https://github.com/S2-/gitlit
synced 2025-08-03 21:00:04 +02:00
initial commit
This commit is contained in:
29
app/node_modules/boom/LICENSE
generated
vendored
Normal file
29
app/node_modules/boom/LICENSE
generated
vendored
Normal file
@@ -0,0 +1,29 @@
|
||||
Copyright (c) 2012-2017, Project contributors.
|
||||
Copyright (c) 2012-2014, Walmart.
|
||||
All rights reserved.
|
||||
|
||||
Redistribution and use in source and binary forms, with or without
|
||||
modification, are permitted provided that the following conditions are met:
|
||||
* Redistributions of source code must retain the above copyright
|
||||
notice, this list of conditions and the following disclaimer.
|
||||
* Redistributions in binary form must reproduce the above copyright
|
||||
notice, this list of conditions and the following disclaimer in the
|
||||
documentation and/or other materials provided with the distribution.
|
||||
* The names of any contributors may not be used to endorse or promote
|
||||
products derived from this software without specific prior written
|
||||
permission.
|
||||
|
||||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
|
||||
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
|
||||
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
||||
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS AND CONTRIBUTORS BE LIABLE FOR ANY
|
||||
DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
|
||||
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
|
||||
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
|
||||
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||||
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
|
||||
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
|
||||
* * *
|
||||
|
||||
The complete list of contributors can be found at: https://github.com/hapijs/boom/graphs/contributors
|
||||
760
app/node_modules/boom/README.md
generated
vendored
Normal file
760
app/node_modules/boom/README.md
generated
vendored
Normal file
@@ -0,0 +1,760 @@
|
||||
|
||||
|
||||
HTTP-friendly error objects
|
||||
|
||||
[](http://travis-ci.org/hapijs/boom)
|
||||
[](https://www.npmjs.com/package/boom)
|
||||
|
||||
Lead Maintainer: [Adam Bretz](https://github.com/arb)
|
||||
|
||||
<!-- toc -->
|
||||
|
||||
- [Boom](#boom)
|
||||
- [Helper Methods](#helper-methods)
|
||||
- [`wrap(error, [statusCode], [message])`](#wraperror-statuscode-message)
|
||||
- [`create(statusCode, [message], [data])`](#createstatuscode-message-data)
|
||||
- [HTTP 4xx Errors](#http-4xx-errors)
|
||||
- [`Boom.badRequest([message], [data])`](#boombadrequestmessage-data)
|
||||
- [`Boom.unauthorized([message], [scheme], [attributes])`](#boomunauthorizedmessage-scheme-attributes)
|
||||
- [`Boom.paymentRequired([message], [data])`](#boompaymentrequiredmessage-data)
|
||||
- [`Boom.forbidden([message], [data])`](#boomforbiddenmessage-data)
|
||||
- [`Boom.notFound([message], [data])`](#boomnotfoundmessage-data)
|
||||
- [`Boom.methodNotAllowed([message], [data], [allow])`](#boommethodnotallowedmessage-data-allow)
|
||||
- [`Boom.notAcceptable([message], [data])`](#boomnotacceptablemessage-data)
|
||||
- [`Boom.proxyAuthRequired([message], [data])`](#boomproxyauthrequiredmessage-data)
|
||||
- [`Boom.clientTimeout([message], [data])`](#boomclienttimeoutmessage-data)
|
||||
- [`Boom.conflict([message], [data])`](#boomconflictmessage-data)
|
||||
- [`Boom.resourceGone([message], [data])`](#boomresourcegonemessage-data)
|
||||
- [`Boom.lengthRequired([message], [data])`](#boomlengthrequiredmessage-data)
|
||||
- [`Boom.preconditionFailed([message], [data])`](#boompreconditionfailedmessage-data)
|
||||
- [`Boom.entityTooLarge([message], [data])`](#boomentitytoolargemessage-data)
|
||||
- [`Boom.uriTooLong([message], [data])`](#boomuritoolongmessage-data)
|
||||
- [`Boom.unsupportedMediaType([message], [data])`](#boomunsupportedmediatypemessage-data)
|
||||
- [`Boom.rangeNotSatisfiable([message], [data])`](#boomrangenotsatisfiablemessage-data)
|
||||
- [`Boom.expectationFailed([message], [data])`](#boomexpectationfailedmessage-data)
|
||||
- [`Boom.teapot([message], [data])`](#boomteapotmessage-data)
|
||||
- [`Boom.badData([message], [data])`](#boombaddatamessage-data)
|
||||
- [`Boom.locked([message], [data])`](#boomlockedmessage-data)
|
||||
- [`Boom.preconditionRequired([message], [data])`](#boompreconditionrequiredmessage-data)
|
||||
- [`Boom.tooManyRequests([message], [data])`](#boomtoomanyrequestsmessage-data)
|
||||
- [`Boom.illegal([message], [data])`](#boomillegalmessage-data)
|
||||
- [HTTP 5xx Errors](#http-5xx-errors)
|
||||
- [`Boom.badImplementation([message], [data])` - (*alias: `internal`*)](#boombadimplementationmessage-data---alias-internal)
|
||||
- [`Boom.notImplemented([message], [data])`](#boomnotimplementedmessage-data)
|
||||
- [`Boom.badGateway([message], [data])`](#boombadgatewaymessage-data)
|
||||
- [`Boom.serverUnavailable([message], [data])`](#boomserverunavailablemessage-data)
|
||||
- [`Boom.gatewayTimeout([message], [data])`](#boomgatewaytimeoutmessage-data)
|
||||
- [F.A.Q.](#faq)
|
||||
|
||||
<!-- tocstop -->
|
||||
|
||||
# Boom
|
||||
|
||||
**boom** provides a set of utilities for returning HTTP errors. Each utility returns a `Boom` error response
|
||||
object (instance of `Error`) which includes the following properties:
|
||||
- `isBoom` - if `true`, indicates this is a `Boom` object instance.
|
||||
- `isServer` - convenience bool indicating status code >= 500.
|
||||
- `message` - the error message.
|
||||
- `output` - the formatted response. Can be directly manipulated after object construction to return a custom
|
||||
error response. Allowed root keys:
|
||||
- `statusCode` - the HTTP status code (typically 4xx or 5xx).
|
||||
- `headers` - an object containing any HTTP headers where each key is a header name and value is the header content.
|
||||
- `payload` - the formatted object used as the response payload (stringified). Can be directly manipulated but any
|
||||
changes will be lost
|
||||
if `reformat()` is called. Any content allowed and by default includes the following content:
|
||||
- `statusCode` - the HTTP status code, derived from `error.output.statusCode`.
|
||||
- `error` - the HTTP status message (e.g. 'Bad Request', 'Internal Server Error') derived from `statusCode`.
|
||||
- `message` - the error message derived from `error.message`.
|
||||
- inherited `Error` properties.
|
||||
|
||||
The `Boom` object also supports the following method:
|
||||
- `reformat()` - rebuilds `error.output` using the other object properties.
|
||||
|
||||
## Helper Methods
|
||||
|
||||
### `wrap(error, [statusCode], [message])`
|
||||
|
||||
Decorates an error with the **boom** properties where:
|
||||
- `error` - the error object to wrap. If `error` is already a **boom** object, returns back the same object.
|
||||
- `statusCode` - optional HTTP status code. Defaults to `500`.
|
||||
- `message` - optional message string. If the error already has a message, it adds the message as a prefix.
|
||||
Defaults to no message.
|
||||
|
||||
```js
|
||||
var error = new Error('Unexpected input');
|
||||
Boom.wrap(error, 400);
|
||||
```
|
||||
|
||||
### `create(statusCode, [message], [data])`
|
||||
|
||||
Generates an `Error` object with the **boom** decorations where:
|
||||
- `statusCode` - an HTTP error code number. Must be greater or equal 400.
|
||||
- `message` - optional message string.
|
||||
- `data` - additional error data set to `error.data` property.
|
||||
|
||||
```js
|
||||
var error = Boom.create(400, 'Bad request', { timestamp: Date.now() });
|
||||
```
|
||||
|
||||
## HTTP 4xx Errors
|
||||
|
||||
### `Boom.badRequest([message], [data])`
|
||||
|
||||
Returns a 400 Bad Request error where:
|
||||
- `message` - optional message.
|
||||
- `data` - optional additional error data.
|
||||
|
||||
```js
|
||||
Boom.badRequest('invalid query');
|
||||
```
|
||||
|
||||
Generates the following response payload:
|
||||
|
||||
```json
|
||||
{
|
||||
"statusCode": 400,
|
||||
"error": "Bad Request",
|
||||
"message": "invalid query"
|
||||
}
|
||||
```
|
||||
|
||||
### `Boom.unauthorized([message], [scheme], [attributes])`
|
||||
|
||||
Returns a 401 Unauthorized error where:
|
||||
- `message` - optional message.
|
||||
- `scheme` can be one of the following:
|
||||
- an authentication scheme name
|
||||
- an array of string values. These values will be separated by ', ' and set to the 'WWW-Authenticate' header.
|
||||
- `attributes` - an object of values to use while setting the 'WWW-Authenticate' header. This value is only used
|
||||
when `scheme` is a string, otherwise it is ignored. Every key/value pair will be included in the
|
||||
'WWW-Authenticate' in the format of 'key="value"' as well as in the response payload under the `attributes` key. Alternatively value can be a string which is use to set the value of the scheme, for example setting the token value for negotiate header. If string is used message parameter must be null.
|
||||
`null` and `undefined` will be replaced with an empty string. If `attributes` is set, `message` will be used as
|
||||
the 'error' segment of the 'WWW-Authenticate' header. If `message` is unset, the 'error' segment of the header
|
||||
will not be present and `isMissing` will be true on the error object.
|
||||
|
||||
If either `scheme` or `attributes` are set, the resultant `Boom` object will have the 'WWW-Authenticate' header set for the response.
|
||||
|
||||
```js
|
||||
Boom.unauthorized('invalid password');
|
||||
```
|
||||
|
||||
Generates the following response:
|
||||
|
||||
```json
|
||||
"payload": {
|
||||
"statusCode": 401,
|
||||
"error": "Unauthorized",
|
||||
"message": "invalid password"
|
||||
},
|
||||
"headers" {}
|
||||
```
|
||||
|
||||
```js
|
||||
Boom.unauthorized('invalid password', 'sample');
|
||||
```
|
||||
|
||||
Generates the following response:
|
||||
|
||||
```json
|
||||
"payload": {
|
||||
"statusCode": 401,
|
||||
"error": "Unauthorized",
|
||||
"message": "invalid password",
|
||||
"attributes": {
|
||||
"error": "invalid password"
|
||||
}
|
||||
},
|
||||
"headers" {
|
||||
"WWW-Authenticate": "sample error=\"invalid password\""
|
||||
}
|
||||
```
|
||||
|
||||
```js
|
||||
Boom.unauthorized(null, 'Negotiate', 'VGhpcyBpcyBhIHRlc3QgdG9rZW4=');
|
||||
```
|
||||
|
||||
Generates the following response:
|
||||
|
||||
```json
|
||||
"payload": {
|
||||
"statusCode": 401,
|
||||
"error": "Unauthorized",
|
||||
"attributes": "VGhpcyBpcyBhIHRlc3QgdG9rZW4="
|
||||
},
|
||||
"headers" {
|
||||
"WWW-Authenticate": "Negotiate VGhpcyBpcyBhIHRlc3QgdG9rZW4="
|
||||
}
|
||||
```
|
||||
|
||||
```js
|
||||
Boom.unauthorized('invalid password', 'sample', { ttl: 0, cache: null, foo: 'bar' });
|
||||
```
|
||||
|
||||
Generates the following response:
|
||||
|
||||
```json
|
||||
"payload": {
|
||||
"statusCode": 401,
|
||||
"error": "Unauthorized",
|
||||
"message": "invalid password",
|
||||
"attributes": {
|
||||
"error": "invalid password",
|
||||
"ttl": 0,
|
||||
"cache": "",
|
||||
"foo": "bar"
|
||||
}
|
||||
},
|
||||
"headers" {
|
||||
"WWW-Authenticate": "sample ttl=\"0\", cache=\"\", foo=\"bar\", error=\"invalid password\""
|
||||
}
|
||||
```
|
||||
|
||||
### `Boom.paymentRequired([message], [data])`
|
||||
|
||||
Returns a 402 Payment Required error where:
|
||||
- `message` - optional message.
|
||||
- `data` - optional additional error data.
|
||||
|
||||
```js
|
||||
Boom.paymentRequired('bandwidth used');
|
||||
```
|
||||
|
||||
Generates the following response payload:
|
||||
|
||||
```json
|
||||
{
|
||||
"statusCode": 402,
|
||||
"error": "Payment Required",
|
||||
"message": "bandwidth used"
|
||||
}
|
||||
```
|
||||
|
||||
### `Boom.forbidden([message], [data])`
|
||||
|
||||
Returns a 403 Forbidden error where:
|
||||
- `message` - optional message.
|
||||
- `data` - optional additional error data.
|
||||
|
||||
```js
|
||||
Boom.forbidden('try again some time');
|
||||
```
|
||||
|
||||
Generates the following response payload:
|
||||
|
||||
```json
|
||||
{
|
||||
"statusCode": 403,
|
||||
"error": "Forbidden",
|
||||
"message": "try again some time"
|
||||
}
|
||||
```
|
||||
|
||||
### `Boom.notFound([message], [data])`
|
||||
|
||||
Returns a 404 Not Found error where:
|
||||
- `message` - optional message.
|
||||
- `data` - optional additional error data.
|
||||
|
||||
```js
|
||||
Boom.notFound('missing');
|
||||
```
|
||||
|
||||
Generates the following response payload:
|
||||
|
||||
```json
|
||||
{
|
||||
"statusCode": 404,
|
||||
"error": "Not Found",
|
||||
"message": "missing"
|
||||
}
|
||||
```
|
||||
|
||||
### `Boom.methodNotAllowed([message], [data], [allow])`
|
||||
|
||||
Returns a 405 Method Not Allowed error where:
|
||||
- `message` - optional message.
|
||||
- `data` - optional additional error data.
|
||||
- `allow` - optional string or array of strings (to be combined and separated by ', ') which is set to the 'Allow' header.
|
||||
|
||||
```js
|
||||
Boom.methodNotAllowed('that method is not allowed');
|
||||
```
|
||||
|
||||
Generates the following response payload:
|
||||
|
||||
```json
|
||||
{
|
||||
"statusCode": 405,
|
||||
"error": "Method Not Allowed",
|
||||
"message": "that method is not allowed"
|
||||
}
|
||||
```
|
||||
|
||||
### `Boom.notAcceptable([message], [data])`
|
||||
|
||||
Returns a 406 Not Acceptable error where:
|
||||
- `message` - optional message.
|
||||
- `data` - optional additional error data.
|
||||
|
||||
```js
|
||||
Boom.notAcceptable('unacceptable');
|
||||
```
|
||||
|
||||
Generates the following response payload:
|
||||
|
||||
```json
|
||||
{
|
||||
"statusCode": 406,
|
||||
"error": "Not Acceptable",
|
||||
"message": "unacceptable"
|
||||
}
|
||||
```
|
||||
|
||||
### `Boom.proxyAuthRequired([message], [data])`
|
||||
|
||||
Returns a 407 Proxy Authentication Required error where:
|
||||
- `message` - optional message.
|
||||
- `data` - optional additional error data.
|
||||
|
||||
```js
|
||||
Boom.proxyAuthRequired('auth missing');
|
||||
```
|
||||
|
||||
Generates the following response payload:
|
||||
|
||||
```json
|
||||
{
|
||||
"statusCode": 407,
|
||||
"error": "Proxy Authentication Required",
|
||||
"message": "auth missing"
|
||||
}
|
||||
```
|
||||
|
||||
### `Boom.clientTimeout([message], [data])`
|
||||
|
||||
Returns a 408 Request Time-out error where:
|
||||
- `message` - optional message.
|
||||
- `data` - optional additional error data.
|
||||
|
||||
```js
|
||||
Boom.clientTimeout('timed out');
|
||||
```
|
||||
|
||||
Generates the following response payload:
|
||||
|
||||
```json
|
||||
{
|
||||
"statusCode": 408,
|
||||
"error": "Request Time-out",
|
||||
"message": "timed out"
|
||||
}
|
||||
```
|
||||
|
||||
### `Boom.conflict([message], [data])`
|
||||
|
||||
Returns a 409 Conflict error where:
|
||||
- `message` - optional message.
|
||||
- `data` - optional additional error data.
|
||||
|
||||
```js
|
||||
Boom.conflict('there was a conflict');
|
||||
```
|
||||
|
||||
Generates the following response payload:
|
||||
|
||||
```json
|
||||
{
|
||||
"statusCode": 409,
|
||||
"error": "Conflict",
|
||||
"message": "there was a conflict"
|
||||
}
|
||||
```
|
||||
|
||||
### `Boom.resourceGone([message], [data])`
|
||||
|
||||
Returns a 410 Gone error where:
|
||||
- `message` - optional message.
|
||||
- `data` - optional additional error data.
|
||||
|
||||
```js
|
||||
Boom.resourceGone('it is gone');
|
||||
```
|
||||
|
||||
Generates the following response payload:
|
||||
|
||||
```json
|
||||
{
|
||||
"statusCode": 410,
|
||||
"error": "Gone",
|
||||
"message": "it is gone"
|
||||
}
|
||||
```
|
||||
|
||||
### `Boom.lengthRequired([message], [data])`
|
||||
|
||||
Returns a 411 Length Required error where:
|
||||
- `message` - optional message.
|
||||
- `data` - optional additional error data.
|
||||
|
||||
```js
|
||||
Boom.lengthRequired('length needed');
|
||||
```
|
||||
|
||||
Generates the following response payload:
|
||||
|
||||
```json
|
||||
{
|
||||
"statusCode": 411,
|
||||
"error": "Length Required",
|
||||
"message": "length needed"
|
||||
}
|
||||
```
|
||||
|
||||
### `Boom.preconditionFailed([message], [data])`
|
||||
|
||||
Returns a 412 Precondition Failed error where:
|
||||
- `message` - optional message.
|
||||
- `data` - optional additional error data.
|
||||
|
||||
```js
|
||||
Boom.preconditionFailed();
|
||||
```
|
||||
|
||||
Generates the following response payload:
|
||||
|
||||
```json
|
||||
{
|
||||
"statusCode": 412,
|
||||
"error": "Precondition Failed"
|
||||
}
|
||||
```
|
||||
|
||||
### `Boom.entityTooLarge([message], [data])`
|
||||
|
||||
Returns a 413 Request Entity Too Large error where:
|
||||
- `message` - optional message.
|
||||
- `data` - optional additional error data.
|
||||
|
||||
```js
|
||||
Boom.entityTooLarge('too big');
|
||||
```
|
||||
|
||||
Generates the following response payload:
|
||||
|
||||
```json
|
||||
{
|
||||
"statusCode": 413,
|
||||
"error": "Request Entity Too Large",
|
||||
"message": "too big"
|
||||
}
|
||||
```
|
||||
|
||||
### `Boom.uriTooLong([message], [data])`
|
||||
|
||||
Returns a 414 Request-URI Too Large error where:
|
||||
- `message` - optional message.
|
||||
- `data` - optional additional error data.
|
||||
|
||||
```js
|
||||
Boom.uriTooLong('uri is too long');
|
||||
```
|
||||
|
||||
Generates the following response payload:
|
||||
|
||||
```json
|
||||
{
|
||||
"statusCode": 414,
|
||||
"error": "Request-URI Too Large",
|
||||
"message": "uri is too long"
|
||||
}
|
||||
```
|
||||
|
||||
### `Boom.unsupportedMediaType([message], [data])`
|
||||
|
||||
Returns a 415 Unsupported Media Type error where:
|
||||
- `message` - optional message.
|
||||
- `data` - optional additional error data.
|
||||
|
||||
```js
|
||||
Boom.unsupportedMediaType('that media is not supported');
|
||||
```
|
||||
|
||||
Generates the following response payload:
|
||||
|
||||
```json
|
||||
{
|
||||
"statusCode": 415,
|
||||
"error": "Unsupported Media Type",
|
||||
"message": "that media is not supported"
|
||||
}
|
||||
```
|
||||
|
||||
### `Boom.rangeNotSatisfiable([message], [data])`
|
||||
|
||||
Returns a 416 Requested Range Not Satisfiable error where:
|
||||
- `message` - optional message.
|
||||
- `data` - optional additional error data.
|
||||
|
||||
```js
|
||||
Boom.rangeNotSatisfiable();
|
||||
```
|
||||
|
||||
Generates the following response payload:
|
||||
|
||||
```json
|
||||
{
|
||||
"statusCode": 416,
|
||||
"error": "Requested Range Not Satisfiable"
|
||||
}
|
||||
```
|
||||
|
||||
### `Boom.expectationFailed([message], [data])`
|
||||
|
||||
Returns a 417 Expectation Failed error where:
|
||||
- `message` - optional message.
|
||||
- `data` - optional additional error data.
|
||||
|
||||
```js
|
||||
Boom.expectationFailed('expected this to work');
|
||||
```
|
||||
|
||||
Generates the following response payload:
|
||||
|
||||
```json
|
||||
{
|
||||
"statusCode": 417,
|
||||
"error": "Expectation Failed",
|
||||
"message": "expected this to work"
|
||||
}
|
||||
```
|
||||
|
||||
### `Boom.teapot([message], [data])`
|
||||
|
||||
Returns a 418 I'm a Teapot error where:
|
||||
- `message` - optional message.
|
||||
- `data` - optional additional error data.
|
||||
|
||||
```js
|
||||
Boom.teapot('sorry, no coffee...');
|
||||
```
|
||||
|
||||
Generates the following response payload:
|
||||
|
||||
```json
|
||||
{
|
||||
"statusCode": 418,
|
||||
"error": "I'm a Teapot",
|
||||
"message": "Sorry, no coffee..."
|
||||
}
|
||||
```
|
||||
|
||||
### `Boom.badData([message], [data])`
|
||||
|
||||
Returns a 422 Unprocessable Entity error where:
|
||||
- `message` - optional message.
|
||||
- `data` - optional additional error data.
|
||||
|
||||
```js
|
||||
Boom.badData('your data is bad and you should feel bad');
|
||||
```
|
||||
|
||||
Generates the following response payload:
|
||||
|
||||
```json
|
||||
{
|
||||
"statusCode": 422,
|
||||
"error": "Unprocessable Entity",
|
||||
"message": "your data is bad and you should feel bad"
|
||||
}
|
||||
```
|
||||
|
||||
### `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:
|
||||
- `message` - optional message.
|
||||
- `data` - optional additional error data.
|
||||
|
||||
```js
|
||||
Boom.preconditionRequired('you must supply an If-Match header');
|
||||
```
|
||||
|
||||
Generates the following response payload:
|
||||
|
||||
```json
|
||||
{
|
||||
"statusCode": 428,
|
||||
"error": "Precondition Required",
|
||||
"message": "you must supply an If-Match header"
|
||||
}
|
||||
```
|
||||
|
||||
### `Boom.tooManyRequests([message], [data])`
|
||||
|
||||
Returns a 429 Too Many Requests error where:
|
||||
- `message` - optional message.
|
||||
- `data` - optional additional error data.
|
||||
|
||||
```js
|
||||
Boom.tooManyRequests('you have exceeded your request limit');
|
||||
```
|
||||
|
||||
Generates the following response payload:
|
||||
|
||||
```json
|
||||
{
|
||||
"statusCode": 429,
|
||||
"error": "Too Many Requests",
|
||||
"message": "you have exceeded your request limit"
|
||||
}
|
||||
```
|
||||
|
||||
### `Boom.illegal([message], [data])`
|
||||
|
||||
Returns a 451 Unavailable For Legal Reasons error where:
|
||||
- `message` - optional message.
|
||||
- `data` - optional additional error data.
|
||||
|
||||
```js
|
||||
Boom.illegal('you are not permitted to view this resource for legal reasons');
|
||||
```
|
||||
|
||||
Generates the following response payload:
|
||||
|
||||
```json
|
||||
{
|
||||
"statusCode": 451,
|
||||
"error": "Unavailable For Legal Reasons",
|
||||
"message": "you are not permitted to view this resource for legal reasons"
|
||||
}
|
||||
```
|
||||
|
||||
## HTTP 5xx Errors
|
||||
|
||||
All 500 errors hide your message from the end user. Your message is recorded in the server log.
|
||||
|
||||
### `Boom.badImplementation([message], [data])` - (*alias: `internal`*)
|
||||
|
||||
Returns a 500 Internal Server Error error where:
|
||||
- `message` - optional message.
|
||||
- `data` - optional additional error data.
|
||||
|
||||
```js
|
||||
Boom.badImplementation('terrible implementation');
|
||||
```
|
||||
|
||||
Generates the following response payload:
|
||||
|
||||
```json
|
||||
{
|
||||
"statusCode": 500,
|
||||
"error": "Internal Server Error",
|
||||
"message": "An internal server error occurred"
|
||||
}
|
||||
```
|
||||
|
||||
### `Boom.notImplemented([message], [data])`
|
||||
|
||||
Returns a 501 Not Implemented error where:
|
||||
- `message` - optional message.
|
||||
- `data` - optional additional error data.
|
||||
|
||||
```js
|
||||
Boom.notImplemented('method not implemented');
|
||||
```
|
||||
|
||||
Generates the following response payload:
|
||||
|
||||
```json
|
||||
{
|
||||
"statusCode": 501,
|
||||
"error": "Not Implemented",
|
||||
"message": "method not implemented"
|
||||
}
|
||||
```
|
||||
|
||||
### `Boom.badGateway([message], [data])`
|
||||
|
||||
Returns a 502 Bad Gateway error where:
|
||||
- `message` - optional message.
|
||||
- `data` - optional additional error data.
|
||||
|
||||
```js
|
||||
Boom.badGateway('that is a bad gateway');
|
||||
```
|
||||
|
||||
Generates the following response payload:
|
||||
|
||||
```json
|
||||
{
|
||||
"statusCode": 502,
|
||||
"error": "Bad Gateway",
|
||||
"message": "that is a bad gateway"
|
||||
}
|
||||
```
|
||||
|
||||
### `Boom.serverUnavailable([message], [data])`
|
||||
|
||||
Returns a 503 Service Unavailable error where:
|
||||
- `message` - optional message.
|
||||
- `data` - optional additional error data.
|
||||
|
||||
```js
|
||||
Boom.serverUnavailable('unavailable');
|
||||
```
|
||||
|
||||
Generates the following response payload:
|
||||
|
||||
```json
|
||||
{
|
||||
"statusCode": 503,
|
||||
"error": "Service Unavailable",
|
||||
"message": "unavailable"
|
||||
}
|
||||
```
|
||||
|
||||
### `Boom.gatewayTimeout([message], [data])`
|
||||
|
||||
Returns a 504 Gateway Time-out error where:
|
||||
- `message` - optional message.
|
||||
- `data` - optional additional error data.
|
||||
|
||||
```js
|
||||
Boom.gatewayTimeout();
|
||||
```
|
||||
|
||||
Generates the following response payload:
|
||||
|
||||
```json
|
||||
{
|
||||
"statusCode": 504,
|
||||
"error": "Gateway Time-out"
|
||||
}
|
||||
```
|
||||
|
||||
## F.A.Q.
|
||||
|
||||
**Q** How do I include extra information in my responses? `output.payload` is missing `data`, what gives?
|
||||
|
||||
**A** There is a reason the values passed back in the response payloads are pretty locked down. It's mostly for security and to not leak any important information back to the client. This means you will need to put in a little more effort to include extra information about your custom error. Check out the ["Error transformation"](https://github.com/hapijs/hapi/blob/master/API.md#error-transformation) section in the hapi documentation.
|
||||
|
||||
---
|
||||
433
app/node_modules/boom/lib/index.js
generated
vendored
Normal file
433
app/node_modules/boom/lib/index.js
generated
vendored
Normal file
@@ -0,0 +1,433 @@
|
||||
'use strict';
|
||||
|
||||
// Load modules
|
||||
|
||||
const Hoek = require('hoek');
|
||||
|
||||
|
||||
// Declare internals
|
||||
|
||||
const internals = {
|
||||
STATUS_CODES: Object.setPrototypeOf({
|
||||
'100': 'Continue',
|
||||
'101': 'Switching Protocols',
|
||||
'102': 'Processing',
|
||||
'200': 'OK',
|
||||
'201': 'Created',
|
||||
'202': 'Accepted',
|
||||
'203': 'Non-Authoritative Information',
|
||||
'204': 'No Content',
|
||||
'205': 'Reset Content',
|
||||
'206': 'Partial Content',
|
||||
'207': 'Multi-Status',
|
||||
'300': 'Multiple Choices',
|
||||
'301': 'Moved Permanently',
|
||||
'302': 'Moved Temporarily',
|
||||
'303': 'See Other',
|
||||
'304': 'Not Modified',
|
||||
'305': 'Use Proxy',
|
||||
'307': 'Temporary Redirect',
|
||||
'400': 'Bad Request',
|
||||
'401': 'Unauthorized',
|
||||
'402': 'Payment Required',
|
||||
'403': 'Forbidden',
|
||||
'404': 'Not Found',
|
||||
'405': 'Method Not Allowed',
|
||||
'406': 'Not Acceptable',
|
||||
'407': 'Proxy Authentication Required',
|
||||
'408': 'Request Time-out',
|
||||
'409': 'Conflict',
|
||||
'410': 'Gone',
|
||||
'411': 'Length Required',
|
||||
'412': 'Precondition Failed',
|
||||
'413': 'Request Entity Too Large',
|
||||
'414': 'Request-URI Too Large',
|
||||
'415': 'Unsupported Media Type',
|
||||
'416': 'Requested Range Not Satisfiable',
|
||||
'417': 'Expectation Failed',
|
||||
'418': 'I\'m a teapot',
|
||||
'422': 'Unprocessable Entity',
|
||||
'423': 'Locked',
|
||||
'424': 'Failed Dependency',
|
||||
'425': 'Unordered Collection',
|
||||
'426': 'Upgrade Required',
|
||||
'428': 'Precondition Required',
|
||||
'429': 'Too Many Requests',
|
||||
'431': 'Request Header Fields Too Large',
|
||||
'451': 'Unavailable For Legal Reasons',
|
||||
'500': 'Internal Server Error',
|
||||
'501': 'Not Implemented',
|
||||
'502': 'Bad Gateway',
|
||||
'503': 'Service Unavailable',
|
||||
'504': 'Gateway Time-out',
|
||||
'505': 'HTTP Version Not Supported',
|
||||
'506': 'Variant Also Negotiates',
|
||||
'507': 'Insufficient Storage',
|
||||
'509': 'Bandwidth Limit Exceeded',
|
||||
'510': 'Not Extended',
|
||||
'511': 'Network Authentication Required'
|
||||
}, null)
|
||||
};
|
||||
|
||||
|
||||
exports.wrap = function (error, statusCode, message) {
|
||||
|
||||
Hoek.assert(error instanceof Error, 'Cannot wrap non-Error object');
|
||||
Hoek.assert(!error.isBoom || (!statusCode && !message), 'Cannot provide statusCode or message with boom error');
|
||||
|
||||
return (error.isBoom ? error : internals.initialize(error, statusCode || 500, message));
|
||||
};
|
||||
|
||||
|
||||
exports.create = function (statusCode, message, data) {
|
||||
|
||||
return internals.create(statusCode, message, data, exports.create);
|
||||
};
|
||||
|
||||
|
||||
internals.create = function (statusCode, message, data, ctor) {
|
||||
|
||||
if (message instanceof Error) {
|
||||
if (data) {
|
||||
message.data = data;
|
||||
}
|
||||
return exports.wrap(message, statusCode);
|
||||
}
|
||||
|
||||
const error = new Error(message ? message : undefined); // Avoids settings null message
|
||||
Error.captureStackTrace(error, ctor); // Filter the stack to our external API
|
||||
error.data = data || null;
|
||||
internals.initialize(error, statusCode);
|
||||
return error;
|
||||
};
|
||||
|
||||
|
||||
internals.initialize = function (error, statusCode, message) {
|
||||
|
||||
const numberCode = parseInt(statusCode, 10);
|
||||
Hoek.assert(!isNaN(numberCode) && numberCode >= 400, 'First argument must be a number (400+):', statusCode);
|
||||
|
||||
error.isBoom = true;
|
||||
error.isServer = numberCode >= 500;
|
||||
|
||||
if (!error.hasOwnProperty('data')) {
|
||||
error.data = null;
|
||||
}
|
||||
|
||||
error.output = {
|
||||
statusCode: numberCode,
|
||||
payload: {},
|
||||
headers: {}
|
||||
};
|
||||
|
||||
error.reformat = internals.reformat;
|
||||
error.reformat();
|
||||
|
||||
if (!message &&
|
||||
!error.message) {
|
||||
|
||||
message = error.output.payload.error;
|
||||
}
|
||||
|
||||
if (message) {
|
||||
error.message = (message + (error.message ? ': ' + error.message : ''));
|
||||
}
|
||||
|
||||
return error;
|
||||
};
|
||||
|
||||
|
||||
internals.reformat = function () {
|
||||
|
||||
this.output.payload.statusCode = this.output.statusCode;
|
||||
this.output.payload.error = internals.STATUS_CODES[this.output.statusCode] || 'Unknown';
|
||||
|
||||
if (this.output.statusCode === 500) {
|
||||
this.output.payload.message = 'An internal server error occurred'; // Hide actual error from user
|
||||
}
|
||||
else if (this.message) {
|
||||
this.output.payload.message = this.message;
|
||||
}
|
||||
};
|
||||
|
||||
|
||||
// 4xx Client Errors
|
||||
|
||||
exports.badRequest = function (message, data) {
|
||||
|
||||
return internals.create(400, message, data, exports.badRequest);
|
||||
};
|
||||
|
||||
|
||||
exports.unauthorized = function (message, scheme, attributes) { // Or function (message, wwwAuthenticate[])
|
||||
|
||||
const err = internals.create(401, message, undefined, exports.unauthorized);
|
||||
|
||||
if (!scheme) {
|
||||
return err;
|
||||
}
|
||||
|
||||
let wwwAuthenticate = '';
|
||||
|
||||
if (typeof scheme === 'string') {
|
||||
|
||||
// function (message, scheme, attributes)
|
||||
|
||||
wwwAuthenticate = scheme;
|
||||
|
||||
if (attributes || message) {
|
||||
err.output.payload.attributes = {};
|
||||
}
|
||||
|
||||
if (attributes) {
|
||||
if (typeof attributes === 'string') {
|
||||
wwwAuthenticate = wwwAuthenticate + ' ' + Hoek.escapeHeaderAttribute(attributes);
|
||||
err.output.payload.attributes = attributes;
|
||||
}
|
||||
else {
|
||||
const names = Object.keys(attributes);
|
||||
for (let i = 0; i < names.length; ++i) {
|
||||
const name = names[i];
|
||||
if (i) {
|
||||
wwwAuthenticate = wwwAuthenticate + ',';
|
||||
}
|
||||
|
||||
let value = attributes[name];
|
||||
if (value === null ||
|
||||
value === undefined) { // Value can be zero
|
||||
|
||||
value = '';
|
||||
}
|
||||
wwwAuthenticate = wwwAuthenticate + ' ' + name + '="' + Hoek.escapeHeaderAttribute(value.toString()) + '"';
|
||||
err.output.payload.attributes[name] = value;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
if (message) {
|
||||
if (attributes) {
|
||||
wwwAuthenticate = wwwAuthenticate + ',';
|
||||
}
|
||||
wwwAuthenticate = wwwAuthenticate + ' error="' + Hoek.escapeHeaderAttribute(message) + '"';
|
||||
err.output.payload.attributes.error = message;
|
||||
}
|
||||
else {
|
||||
err.isMissing = true;
|
||||
}
|
||||
}
|
||||
else {
|
||||
|
||||
// function (message, wwwAuthenticate[])
|
||||
|
||||
const wwwArray = scheme;
|
||||
for (let i = 0; i < wwwArray.length; ++i) {
|
||||
if (i) {
|
||||
wwwAuthenticate = wwwAuthenticate + ', ';
|
||||
}
|
||||
|
||||
wwwAuthenticate = wwwAuthenticate + wwwArray[i];
|
||||
}
|
||||
}
|
||||
|
||||
err.output.headers['WWW-Authenticate'] = wwwAuthenticate;
|
||||
|
||||
return err;
|
||||
};
|
||||
|
||||
|
||||
exports.paymentRequired = function (message, data) {
|
||||
|
||||
return internals.create(402, message, data, exports.paymentRequired);
|
||||
};
|
||||
|
||||
|
||||
exports.forbidden = function (message, data) {
|
||||
|
||||
return internals.create(403, message, data, exports.forbidden);
|
||||
};
|
||||
|
||||
|
||||
exports.notFound = function (message, data) {
|
||||
|
||||
return internals.create(404, message, data, exports.notFound);
|
||||
};
|
||||
|
||||
|
||||
exports.methodNotAllowed = function (message, data, allow) {
|
||||
|
||||
const err = internals.create(405, message, data, exports.methodNotAllowed);
|
||||
|
||||
if (typeof allow === 'string') {
|
||||
allow = [allow];
|
||||
}
|
||||
|
||||
if (Array.isArray(allow)) {
|
||||
err.output.headers.Allow = allow.join(', ');
|
||||
}
|
||||
|
||||
return err;
|
||||
};
|
||||
|
||||
|
||||
exports.notAcceptable = function (message, data) {
|
||||
|
||||
return internals.create(406, message, data, exports.notAcceptable);
|
||||
};
|
||||
|
||||
|
||||
exports.proxyAuthRequired = function (message, data) {
|
||||
|
||||
return internals.create(407, message, data, exports.proxyAuthRequired);
|
||||
};
|
||||
|
||||
|
||||
exports.clientTimeout = function (message, data) {
|
||||
|
||||
return internals.create(408, message, data, exports.clientTimeout);
|
||||
};
|
||||
|
||||
|
||||
exports.conflict = function (message, data) {
|
||||
|
||||
return internals.create(409, message, data, exports.conflict);
|
||||
};
|
||||
|
||||
|
||||
exports.resourceGone = function (message, data) {
|
||||
|
||||
return internals.create(410, message, data, exports.resourceGone);
|
||||
};
|
||||
|
||||
|
||||
exports.lengthRequired = function (message, data) {
|
||||
|
||||
return internals.create(411, message, data, exports.lengthRequired);
|
||||
};
|
||||
|
||||
|
||||
exports.preconditionFailed = function (message, data) {
|
||||
|
||||
return internals.create(412, message, data, exports.preconditionFailed);
|
||||
};
|
||||
|
||||
|
||||
exports.entityTooLarge = function (message, data) {
|
||||
|
||||
return internals.create(413, message, data, exports.entityTooLarge);
|
||||
};
|
||||
|
||||
|
||||
exports.uriTooLong = function (message, data) {
|
||||
|
||||
return internals.create(414, message, data, exports.uriTooLong);
|
||||
};
|
||||
|
||||
|
||||
exports.unsupportedMediaType = function (message, data) {
|
||||
|
||||
return internals.create(415, message, data, exports.unsupportedMediaType);
|
||||
};
|
||||
|
||||
|
||||
exports.rangeNotSatisfiable = function (message, data) {
|
||||
|
||||
return internals.create(416, message, data, exports.rangeNotSatisfiable);
|
||||
};
|
||||
|
||||
|
||||
exports.expectationFailed = function (message, data) {
|
||||
|
||||
return internals.create(417, message, data, exports.expectationFailed);
|
||||
};
|
||||
|
||||
|
||||
exports.teapot = function (message, data) {
|
||||
|
||||
return internals.create(418, message, data, exports.teapot);
|
||||
};
|
||||
|
||||
|
||||
exports.badData = function (message, data) {
|
||||
|
||||
return internals.create(422, message, data, exports.badData);
|
||||
};
|
||||
|
||||
|
||||
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);
|
||||
};
|
||||
|
||||
|
||||
exports.tooManyRequests = function (message, data) {
|
||||
|
||||
return internals.create(429, message, data, exports.tooManyRequests);
|
||||
};
|
||||
|
||||
|
||||
exports.illegal = function (message, data) {
|
||||
|
||||
return internals.create(451, message, data, exports.illegal);
|
||||
};
|
||||
|
||||
|
||||
// 5xx Server Errors
|
||||
|
||||
exports.internal = function (message, data, statusCode) {
|
||||
|
||||
return internals.serverError(message, data, statusCode, exports.internal);
|
||||
};
|
||||
|
||||
|
||||
internals.serverError = function (message, data, statusCode, ctor) {
|
||||
|
||||
let error;
|
||||
if (data instanceof Error) {
|
||||
error = exports.wrap(data, statusCode, message);
|
||||
}
|
||||
else {
|
||||
error = internals.create(statusCode || 500, message, undefined, ctor);
|
||||
error.data = data;
|
||||
}
|
||||
|
||||
return error;
|
||||
};
|
||||
|
||||
|
||||
exports.notImplemented = function (message, data) {
|
||||
|
||||
return internals.serverError(message, data, 501, exports.notImplemented);
|
||||
};
|
||||
|
||||
|
||||
exports.badGateway = function (message, data) {
|
||||
|
||||
return internals.serverError(message, data, 502, exports.badGateway);
|
||||
};
|
||||
|
||||
|
||||
exports.serverUnavailable = function (message, data) {
|
||||
|
||||
return internals.serverError(message, data, 503, exports.serverUnavailable);
|
||||
};
|
||||
|
||||
|
||||
exports.gatewayTimeout = function (message, data) {
|
||||
|
||||
return internals.serverError(message, data, 504, exports.gatewayTimeout);
|
||||
};
|
||||
|
||||
|
||||
exports.badImplementation = function (message, data) {
|
||||
|
||||
const err = internals.serverError(message, data, 500, exports.badImplementation);
|
||||
err.isDeveloperError = true;
|
||||
return err;
|
||||
};
|
||||
61
app/node_modules/boom/package.json
generated
vendored
Normal file
61
app/node_modules/boom/package.json
generated
vendored
Normal file
@@ -0,0 +1,61 @@
|
||||
{
|
||||
"_from": "boom@4.x.x",
|
||||
"_id": "boom@4.3.1",
|
||||
"_inBundle": false,
|
||||
"_integrity": "sha1-T4owBctKfjiJ90kDD9JbluAdLjE=",
|
||||
"_location": "/boom",
|
||||
"_phantomChildren": {},
|
||||
"_requested": {
|
||||
"type": "range",
|
||||
"registry": true,
|
||||
"raw": "boom@4.x.x",
|
||||
"name": "boom",
|
||||
"escapedName": "boom",
|
||||
"rawSpec": "4.x.x",
|
||||
"saveSpec": null,
|
||||
"fetchSpec": "4.x.x"
|
||||
},
|
||||
"_requiredBy": [
|
||||
"/hawk"
|
||||
],
|
||||
"_resolved": "https://registry.npmjs.org/boom/-/boom-4.3.1.tgz",
|
||||
"_shasum": "4f8a3005cb4a7e3889f749030fd25b96e01d2e31",
|
||||
"_spec": "boom@4.x.x",
|
||||
"_where": "E:\\projects\\p\\gitlit\\app\\node_modules\\hawk",
|
||||
"bugs": {
|
||||
"url": "https://github.com/hapijs/boom/issues"
|
||||
},
|
||||
"bundleDependencies": false,
|
||||
"dependencies": {
|
||||
"hoek": "4.x.x"
|
||||
},
|
||||
"deprecated": false,
|
||||
"description": "HTTP-friendly error objects",
|
||||
"devDependencies": {
|
||||
"code": "4.x.x",
|
||||
"lab": "13.x.x",
|
||||
"markdown-toc": "0.12.x"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">=4.0.0"
|
||||
},
|
||||
"homepage": "https://github.com/hapijs/boom#readme",
|
||||
"keywords": [
|
||||
"error",
|
||||
"http"
|
||||
],
|
||||
"license": "BSD-3-Clause",
|
||||
"main": "lib/index.js",
|
||||
"name": "boom",
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "git://github.com/hapijs/boom.git"
|
||||
},
|
||||
"scripts": {
|
||||
"test": "lab -a code -t 100 -L -v",
|
||||
"test-cov-html": "lab -a code -r html -o coverage.html -L",
|
||||
"toc": "node generate-toc.js",
|
||||
"version": "npm run toc && git add README.md"
|
||||
},
|
||||
"version": "4.3.1"
|
||||
}
|
||||
Reference in New Issue
Block a user