Class to wrap an HTTP response in a JSend Specification format.

The status string (success, fail, error) is calculated along with the HTTP status code of the response:

• If the status code is greater or equal to 500, status is set to error
• If the status code is greater or equal to 400 and strictly lower to 500, status is set to fail
• Otherwise, status is set to success

npm GitHub Workflow Status Codecov

yarn add @untemps/jsend-wrapper

Import JSendWrapper:

import { JSendWrapper } from '@untemps/jsend-wrapper'

Create an instance of JSendWrapper:

const jsend = new JSendWrapper()

Call the wrap method passing two mandatory and two optional arguments:

jsend.wrap([statusCode], [body], [errorCode], [errorData])

The type of the body argument depends on the status:

{
 status: 'success',
 data: {
 post: {
 id: 1,
 title: 'A blog post',
 body: 'Some useful content'
 }
 }
}

{
 status: 'fail', 
 data: {
 	title: 'A title is required'
 }
}

{
 status: 'error', 
 message: 'Unable to communicate with database'
}

A JSendError class is provided to help throwing specific JSend errors.

The constructor accepts either plain message, code, data arguments or a JSendResponse object:

import { JSendError } from '@untemps/jsend-wrapper'
throw new JSendError('HTTP Error', 500, { someValue: 42 })
throw new JSendError({ status: 'error', message: 'HTTP Error', code: 500, data: { someValue: 42 })

Besides the class wrapper, the lib exports the definitions for the response type (TJSendResponse) and the status enum (EJSendStatus).

status: EJSendStatus
data?: any
message?: string,
code?: number

SUCCESS = 'success'
FAIL = 'fail'
ERROR = 'error'

For more information about the JSend Spec, see the GitHub README here : https://github.com/omniti-labs/jsend