@kalkuz/express-respond-status v1.0.0

Express Respond Status

Express Respond Status is a middleware for Express that adds response methods using the response object. This method allows you to easily send a response with a status code and a JSON body. It provides explanatory method names for each status code.

Installation

You can install this package using npm:

npm install @kalkuz/express-respond-status

Using yarn:

yarn add @kalkuz/express-respond-status

Dependencies

Express Respond Status only depends on Express.

Usage

Importing The Package

import Respond from '@kalkuz/express-respond-status';

Responding Requests

Example success responses:

// HTTP 200
Respond.OK(res, { somedata: 'somevalue' }, 'Any response message here');

// HTTP 201
Respond.Created(res, { somedata: 'somevalue' }, 'Any response message here');

// HTTP 202
Respond.Accepted(res, { somedata: 'somevalue' }, 'Any response message here');

Example error responses:

// HTTP 400
Respond.BadRequest(res,  { somedata: 'somevalue' }, 'Any response message here');

// HTTP 401
Respond.Unauthorized(res,  { somedata: 'somevalue' }, 'Any response message here');

// HTTP 403
Respond.Forbidden(res,  { somedata: 'somevalue' }, 'Any response message here');

Notes

• The data parameter is optional. If you don't want to send any data, you can pass null or undefined as the second parameter.

• The message parameter is optional. If you don't want to send any message, you can pass null or undefined as the third parameter.

Available Methods

License

MIT License