http-response-client v1.1.0

http-response-client

Package to format service request in Moodle web service format

Table of Contents

• http-response-client
  • Table of Contents
  • Installation
  • Examples
    • Create an http error
      • Existent http error
      • Adding a custom message
    • Create a custom error
    • Verify if an error is an http error
  • Docs
  • HTTP Code Responses List
  • Issues
    • 🐛 Bugs
    • 💡 Feature Requests
  • Contributors
  • LICENSE

Installation

This is a Node.js module available through the npm registry.

Before installing, download and install Node.js.

If this is a brand new project, make sure to create a package.json first with the npm init command.

Installation is done using the npm install command:

$ npm install http-response-client

Examples

Create an http error

Existent http error

If you want use any http error that exists in the HTTP code responses you can use the method httpErrors.${error}.

import responseClient from "http-response-client";
const error = new responseClient.errors.NotFound();

Adding a custom message

If you want add a custom message to the error you can pass the message as a parameter to the class.

import responseClient from "http-response-client";
const error = new responseClient.errors.NotFound({msg:"Custom message"});

Create a custom error

If you want create a custom error you can use the function createError and pass the status code, name and the message as parameters.

import responseClient from "http-response-client";
const error = responseClient.createError(404, {name: "CustomName", msg: "Custom message" });

Verify if an error is an http error

If you want verify if an error is an http error you can use the function isHttpError and pass the error as a parameter.

import responseClient from "http-response-client";
const error = new responseClient.errors.NotFound();
const isHttpError = responseClient.isHttpError(error);

Using middleware for express

If you want use the middleware for express you can use the function middlewares and pass the error as a parameter and response.

import responseClient from "http-response-client";
this.app.use((err: Error, req: Request, res: Response, next: NextFunction): void => {
    responseClient.middlewares.errorCatcher(err,res);
});

Docs

HTTP code responses

HTTP Code Responses List

Issues

Looking to contribute? Look for the label.

🐛 Bugs

Please file an issue for bugs, missing documentation, or unexpected behavior.

See Bugs

💡 Feature Requests

Please file an issue to suggest new features. Vote on feature requests by adding a 👍. This helps maintainers prioritize what to work on.

See Feature Requests

Contributors

LICENSE

MIT