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

express-service-handler

v3.0.0

Published

A simple reusable function to handle responses from Express.JS services

Downloads

1,411

Readme

express-service-handler

About this package

This is a simple utility function for handling responses in a specific format from Express services.

Usage

  1. Install using "npm i express-service-handler".
  2. Import the module into your code:
import { handleServiceResponse } from "express-service-handler";
  1. Use the function to handle your service response:
import express from "express";
import { handleServiceResponse } from "express-service-handler";

const app = express();

app.get("/api/data", (req, res) => {
  // Assume getDataFromService is a function that fetches data from a service
  // and returns an object with the following structure:
  // { ok: boolean, status: number, reason: string, data: any }
  const result = getDataFromService();

  // Use handleServiceResponse to send the response
  handleServiceResponse({ res, result });
});

app.listen(3000, () => {
  console.log("Server is running on port 3000");
});

Parameters

The handleServiceResponse function takes an object with the following parameters:

  • res: The response object from the Express.js route handler. This is used to send the response to the client.

  • result: An object containing the result of the service operation. This object should have the following properties:

    • ok: A boolean indicating whether the operation was successful.
    • status: (Optional) A number representing the HTTP status code. If not provided, defaults to 200 for successful operations and 400 for unsuccessful ones.
    • reason: (Optional) A string providing more details in case of an unsuccessful operation.
    • data: (Optional) The data resulting from the operation, if any.
  • sendResponse: (Optional) A boolean indicating whether to send the response immediately. If set to false, the function will return the result object without sending the response. Defaults to true.

Version Notes

  • Added handling of HTTP responses from remote services accessed via an Express API route

Possible breaking changes in v2.0.0

  • The function is now async; review how you're using it and adjust accordingly.

License

Copyright Sean Patrick Wallace 2024

This package is free software. Please see LICENSE.md for further details.