HTTP-friendly error objects

[pretty-errors]

Lead Maintainer: Sahil Arora

• pretty-errors
  • Helper Methods
    • create(statusCode, message, [data])
  • HTTP 4xx Errors
    • badRequest(message, [data])
    • unauthorized(message, [scheme])
    • forbidden(message, [data])
    • notFound(message, [data])
    • methodNotAllowed(message, [data])
    • notAcceptable(message, [data])
    • proxyAuthRequired(message, [data])
    • clientTimeout(message, [data])
    • conflict(message, [data])
    • resourceGone(message, [data])
    • lengthRequired(message, [data])
    • preconditionFailed(message, [data])
    • entityTooLarge(message, [data])
    • uriTooLong(message, [data])
    • unsupportedMediaType(message, [data])
    • rangeNotSatisfiable(message, [data])
    • expectationFailed(message, [data])
    • badData(message, [data])
    • preconditionRequired(message, [data])
    • tooManyRequests(message, [data])
    • illegal(message, [data])
  • HTTP 5xx Errors
    • badImplementation(message, [data])
    • notImplemented(message, [data])
    • badGateway(message, [data])
    • serverTimeout(message, [data])
    • gatewayTimeout(message, [data])

pretty-errors

pretty-errors provides a set of utilities for returning HTTP errors. Each utility returns a pretty-errors error response object (instance of Error) which includes the following properties: statusCode: 400, message: message

• statusCode - the error code.
• message - the error message.
• all the keys in data json and corresponding values

create(statusCode, message, [data])

Generates an Error object with the pretty-codes decorations where:

• statusCode - an HTTP error code number. Must be greater or equal 400.
• message - message string.
• data - additional error data set to error.data property.

var error = create(400, 'Bad request', { timestamp: Date.now() });

HTTP 4xx Errors

badRequest(message, [data])

Returns a 400 Bad Request error where:

• message - message.
• data - optional additional error data.

badRequest('invalid query');

Generates the following response payload:

{
    "statusCode": 400,
    "message": "invalid query"
}

unauthorized(message, [scheme])

Returns a 401 Unauthorized error where:

• message - message.
• data - optional additional error data.

unauthorized('invalid password');

Generates the following response:

{
    "statusCode": 401,
    "message": "invalid password"
},
"headers" {}

unauthorized('invalid password');

Generates the following response:

{
    "statusCode": 401,
    "message": "invalid password",
},

unauthorized('invalid password', { ttl: 0, cache: null, foo: 'bar' });

Generates the following response:

{
    "statusCode": 401,
    "message": "invalid password",
    "ttl": 0,
    "cache": "",
    "foo": "bar"
},

forbidden(message, [data])

Returns a 403 Forbidden error where:

• message - message.
• data - optional additional error data.

forbidden('try again some time');

Generates the following response payload:

{
    "statusCode": 403,
    "message": "try again some time"
}

notFound(message, [data])

Returns a 404 Not Found error where:

• message - message.
• data - optional additional error data.

notFound('missing');

Generates the following response payload:

{
    "statusCode": 404,
    "message": "missing"
}

methodNotAllowed(message, [data])

Returns a 405 Method Not Allowed error where:

• message - message.
• data - optional additional error data.

methodNotAllowed('that method is not allowed');

Generates the following response payload:

{
    "statusCode": 405,
    "message": "that method is not allowed"
}

notAcceptable(message, [data])

Returns a 406 Not Acceptable error where:

• message - message.
• data - optional additional error data.

notAcceptable('unacceptable');

Generates the following response payload:

{
    "statusCode": 406,
    "message": "unacceptable"
}

proxyAuthRequired(message, [data])

Returns a 407 Proxy Authentication Required error where:

• message - message.
• data - optional additional error data.

proxyAuthRequired('auth missing');

Generates the following response payload:

{
    "statusCode": 407,
    "message": "auth missing"
}

clientTimeout(message, [data])

Returns a 408 Request Time-out error where:

• message - message.
• data - optional additional error data.

clientTimeout('timed out');

Generates the following response payload:

{
    "statusCode": 408,
    "message": "timed out"
}

conflict(message, [data])

Returns a 409 Conflict error where:

• message - message.
• data - optional additional error data.

conflict('there was a conflict');

Generates the following response payload:

{
    "statusCode": 409,
    "message": "there was a conflict"
}

resourceGone(message, [data])

Returns a 410 Gone error where:

• message - message.
• data - optional additional error data.

resourceGone('it is gone');

Generates the following response payload:

{
    "statusCode": 410,
    "message": "it is gone"
}

lengthRequired(message, [data])

Returns a 411 Length Required error where:

• message - message.
• data - optional additional error data.

lengthRequired('length needed');

Generates the following response payload:

{
    "statusCode": 411,
    "message": "length needed"
}

preconditionFailed(message, [data])

Returns a 412 Precondition Failed error where:

• message - message.
• data - optional additional error data.

preconditionFailed();

Generates the following response payload:

{
    "statusCode": 412,
    }

entityTooLarge(message, [data])

Returns a 413 Request Entity Too Large error where:

• message - message.
• data - optional additional error data.

entityTooLarge('too big');

Generates the following response payload:

{
    "statusCode": 413,
    "message": "too big"
}

uriTooLong(message, [data])

Returns a 414 Request-URI Too Large error where:

• message - message.
• data - optional additional error data.

uriTooLong('uri is too long');

Generates the following response payload:

{
    "statusCode": 414,
    "message": "uri is too long"
}

unsupportedMediaType(message, [data])

Returns a 415 Unsupported Media Type error where:

• message - message.
• data - optional additional error data.

unsupportedMediaType('that media is not supported');

Generates the following response payload:

{
    "statusCode": 415,
    "message": "that media is not supported"
}

rangeNotSatisfiable(message, [data])

Returns a 416 Requested Range Not Satisfiable error where:

• message - message.
• data - optional additional error data.

rangeNotSatisfiable();

Generates the following response payload:

{
    "statusCode": 416,
    }

expectationFailed(message, [data])

Returns a 417 Expectation Failed error where:

• message - message.
• data - optional additional error data.

expectationFailed('expected this to work');

Generates the following response payload:

{
    "statusCode": 417,
    "message": "expected this to work"
}

badData(message, [data])

Returns a 422 Unprocessable Entity error where:

• message - message.
• data - optional additional error data.

badData('your data is bad and you should feel bad');

Generates the following response payload:

{
    "statusCode": 422,
    "message": "your data is bad and you should feel bad"
}

preconditionRequired(message, [data])

Returns a 428 Precondition Required error where:

• message - message.
• data - optional additional error data.

preconditionRequired('you must supply an If-Match header');

Generates the following response payload:

{
    "statusCode": 428,
    "message": "you must supply an If-Match header"
}

tooManyRequests(message, [data])

Returns a 429 Too Many Requests error where:

• message - message.
• data - optional additional error data.

tooManyRequests('you have exceeded your request limit');

Generates the following response payload:

{
    "statusCode": 429,
    "message": "you have exceeded your request limit"
}

illegal(message, [data])

Returns a 451 Unavailable For Legal Reasons error where:

• message - message.
• data - optional additional error data.

illegal('you are not permitted to view this resource for legal reasons');

Generates the following response payload:

{
    "statusCode": 451,
    "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.

badImplementation(message, [data])

Returns a 500 Internal Server Error error where:

• message - message.
• data - optional additional error data.

badImplementation('terrible implementation');

Generates the following response payload:

{
    "statusCode": 500,
    "message": "An internal server error occurred"
}

notImplemented(message, [data])

Returns a 501 Not Implemented error where:

• message - message.
• data - optional additional error data.

notImplemented('method not implemented');

Generates the following response payload:

{
    "statusCode": 501,
    "message": "method not implemented"
}

badGateway(message, [data])

Returns a 502 Bad Gateway error where:

• message - message.
• data - optional additional error data.

badGateway('that is a bad gateway');

Generates the following response payload:

{
    "statusCode": 502,
    "message": "that is a bad gateway"
}

serverTimeout(message, [data])

Returns a 503 Service Unavailable error where:

• message - message.
• data - optional additional error data.

serverTimeout('unavailable');

Generates the following response payload:

{
    "statusCode": 503,
    "message": "unavailable"
}

gatewayTimeout(message, [data])

Returns a 504 Gateway Time-out error where:

• message - message.
• data - optional additional error data.

gatewayTimeout("error");

Generates the following response payload:

{
    "message": "error"
    "statusCode": 504,
}