@fiswat/response v1.0.3

@fiswat/response

A simple library to handle function and network responses.

Installation

Install this package using npm: npm install @fiswat/response

Usage

MethodResponse

The MethodResponse class provides a way to handle function responses. Require or import it from the package:

// CommonJS (require)
const { MethodResponse } = require('@fiswat/response');

// ECMAScript (import)
import { MethodResponse } from '@fiswat/response';

Return Data

To return data from method, use MethodResponse.Data.return(data, statusCode):

const successMsg = 'Success!'; // Can also be an array or object literal
const statusCode = 200;
return MethodResponse.Data.return(successData, statusCode);
// returns {data : 'Success!' , status: 200}

Return Error

To return an error from method, use MethodResponse.Error.return(data, statusCode):

const errorMsg = 'Something went wrong!'; // Can also be an array or object literal
const statusCode = 500;
const stackData = 'Something else went wrong!'; // Can also be an array or object literal
...
// Return an error object with status code
return MethodResponse.Error.return(errorMsg, statusCode);
// returns {error : 'Something went wrong!', status: 500}

                              or
// Return an error object with status code and root cause (chain error/error stack)
return MethodResponse.Error.returnWithStack(errorMsg, statusCode, stackData);
// returns {error : 'Something went wrong!', status: 500, meta: 'Something else went wrong!' }

ApiResponse

The ApiResponse class provides a way to handle API responses. Require or import it from the package:

// CommonJS (require)
const { ApiResponse } = require('@fiswat/response');

// ECMAScript (import)
import { ApiResponse } from '@fiswat/response';

Success Response

To send a success response, use ApiResponse.Success.send(data, expressResponseObject):

app.get("/",(req,res)=>{
    ...
    ...
    const response = {id: 1, name: "fiswat", status: 200};
    return ApiResponse.Success.send(response, res);
})

Failure Response

To send a failure response, use ApiResponse.Failure.send(data, expressResponseObject):

app.get("/",(req,res)=>{
    ...
    ...
    const response = {error: "Can not proceed", status: 401};
    return ApiResponse.Failure.send(response, res);
})

AxiosResponse

The AxiosResponse class provides a way to handle Axios responses. Require or import it from the package:

// CommonJS (require)
const { AxiosResponse } = require('@fiswat/response');

// ECMAScript (import)
import { AxiosResponse } from '@fiswat/response';

Handle all kind of axios responses

To handle all kind of axios response, use AxiosResponse.handle(response):

let response;
try{
    response = axios({...})
}catch(err){
    response = err;
}

return AxiosResponse.handle(response)
// returns {data: {...}} or {error: {...}}