Response Format
Module which provides HTTP-friendly error objects
Author: Gaurav Joshi
- Response-format
- Methods
create(statusCode, [error, message, data])
success([message, data])
badRequest([message, data])
unAuthorized([message, data])
forbidden([message, data])
notFound([message, data])
notAllowed([message, data])
requestTimeout([message, data])
internalError([message, data])
badGateway([message, data])
unavailable([message, data])
gatewayTimeout([message, data])
- Methods
Start
const Format = ;
Each utility returns an Object which includes the following properties:
error
- true, false or null (if not specified).statusCode
- the HTTP status code.message
- string containing message (if not specified will return a pre-defined set of messages according to status code )data
- response payload (null in case of blank or error)
Methods
create(statusCode, [error, message, data])
Generates a decorated response object where:
statusCode
- an HTTP error code number.message
- optional message string.data
- response payload.error
- true, false or null (if not specified).
success([message, data])
Returns a 200 Success where:
statusCode
- 200error
- falsemessage
- optional message.data
- optional payload.
Format;
Generates the following response payload:
badRequest([message, data])
Returns a 400 Error where:
statusCode
- 400error
- truemessage
- optional message.data
- optional payload.
Format;
Generates the following response payload:
unAuthorized([message, data])
Returns a 402 Error where:
statusCode
- 402error
- truemessage
- optional message.data
- optional payload.
FormatunAuth;
Generates the following response payload:
forbidden([message, data])
Returns a 403 Error where:
statusCode
- 403error
- truemessage
- optional message.data
- optional payload.
Format;
Generates the following response payload:
notFound([message, data])
Returns a 404 Error where:
statusCode
- 404error
- truemessage
- optional message.data
- optional payload.
Format;
Generates the following response payload:
notAllowed([message, data])
Returns a 405 Error where:
statusCode
- 405error
- truemessage
- optional message.data
- optional payload.
Format;
Generates the following response payload:
requestTimeout([message, data])
Returns a 408 Error where:
statusCode
- 408error
- truemessage
- optional message.data
- optional payload.
Format;
Generates the following response payload:
internalError([message, data])
Returns a 500 Error where:
statusCode
- 500error
- truemessage
- optional message.data
- optional payload.
Format;
Generates the following response payload:
badGateway([message, data])
Returns a 502 Error where:
statusCode
- 502error
- truemessage
- optional message.data
- optional payload.
Format;
Generates the following response payload:
unavailable([message, data])
Returns a 503 Error where:
statusCode
- 503error
- truemessage
- optional message.data
- optional payload.
Format;
Generates the following response payload:
gatewayTimeout([message, data])
Returns a 504 Error where:
statusCode
- 504error
- truemessage
- optional message.data
- optional payload.
Format;
Generates the following response payload: