npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@ali-hajeh/response-handler

v0.0.2

Published

A package to help organize responses from your Express.js API

Downloads

3

Readme

@ali-hajeh/response-handler

A lightweight and flexible package to help organize and standardize responses from your Express.js API.

Installation

Install the package using npm:

npm install @ali-hajeh/response-handler

Usage

Import the ResponseHandler class in your Express.js application:

import ResponseHandler from "@ali-hajeh/response-handler";

Middleware Setup

To use the ResponseHandler, you need to set it up as middleware in your Express application:

import express from "express";
import ResponseHandler from "@ali-hajeh/response-handler";

const app = express();

// Apply the middleware
app.use(ResponseHandler.middleware());

Available Methods

Once the middleware is set up, the following methods will be available on the res object in your route handlers:

  1. success: Send a success response
  2. badRequest: Send a bad request response
  3. joiValidationError: Send a response for Joi validation errors
  4. notFound: Send a not found response
  5. serverError: Send a server error response

Example

import express from "express";
import ResponseHandler from "@ali-hajeh/response-handler";

const app = express();

// Apply the middleware
app.use(ResponseHandler.middleware());

app.get("/api/users", (req, res) => {
  // Your logic here
  const users = [{ id: 1, name: "John Doe" }];
  res.success({
    data: users,
    message: "Users retrieved successfully",
  });
});

app.use((req, res) => {
  res.notFound({ message: "Route not found" });
});

app.use((err, req, res, next) => {
  res.serverError({ message: err.message });
});

API Reference

res.success(options)

Send a success response.

  • options:
    • message (optional): Success message (default: "Success")
    • data (optional): Data to be sent in the response
    • statusCode (optional): HTTP status code (default: 200)

res.badRequest(options)

Send a bad request response.

  • options:
    • message (optional): Error message (default: "Bad Request")
    • errors (optional): Error details
    • statusCode (optional): HTTP status code (default: 400)

res.joiValidationError(error, options)

Send a response for Joi validation errors.

  • error: Joi ValidationError object
  • options:
    • statusCode (optional): HTTP status code (default: 400)

res.notFound(options)

Send a not found response.

  • options:
    • message (optional): Error message (default: "Not Found")
    • errors (optional): Error details
    • statusCode (optional): HTTP status code (default: 404)

res.serverError(options)

Send a server error response.

  • options:
    • message (optional): Error message (default: "Internal Server Error")
    • errors (optional): Error details
    • statusCode (optional): HTTP status code (default: 500)

Custom Methods

You can add custom response methods using the ResponseHandler.addCustomMethod function:

ResponseHandler.addCustomMethod<[data: any, options?: { flag?: boolean }]>(
  "customResponse",
  function (data, options = {}) {
    return this.status(200).json({ custom: true, data, ...options });
  }
);

// Usage in a route
app.get("/custom", (req, res) => {
  res.customResponse({ foo: "bar" }, { flag: true });
});

TypeScript Support

This package is written in TypeScript and includes type definitions. It exports a ResponseType interface that you can use to type your responses:

import { ResponseType } from "@ali-hajeh/response-handler";

const response: ResponseType = {
  success: true,
  message: "Success",
  data: { id: 1 },
  statusCode: 200,
};

Contributing

Contributions are welcome! Please feel free to submit a Pull Request or an Issue.

License

This project is licensed under the ISC License.