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

@ahextechnology/sucess-error-responses

v1.0.0

Published

This module provides a set of classes and functions for handling errors and sending responses in a Node.js application. It includes custom error classes, a status class, pagination support, and utility functions for error handling and sending structured r

Downloads

22

Readme

Error Handling and Response Module

This module provides a set of classes and functions for handling errors and sending responses in a Node.js application. It includes custom error classes, a status class, pagination support, and utility functions for error handling and sending structured responses.

Installation

To install the module, run:

npm install @ahextechnology/sucess-error-responses

Usage

Importing the Module

const {
  NoResponseError,
  ServerError,
  ClientError,
  Status,
  Pagination,
  handleError,
  sendResponse
} = require('your-package-name');
const logger = require('./shared/utils/logger');
const ERROR_MESSAGES = require('./shared/enums/error-messages');
const AUDIT_STATUS = require('./shared/enums/audit-logs-enums').Status;

Note:

Reassign the Error messages path to respective paths

Example Usage

Error Handling

const express = require('express');
const app = express();

app.use(express.json());

app.get('/example', async (req, res, next) => {
    try {
        // Simulate an error
        throw new ServerError(500, ERROR_MESSAGES.INTERNAL_SERVER_ERROR_500, ERROR_MESSAGES.CONTACT_ADMINISTRATOR);
    } catch (err) {
        // Handle the error
        handleError(err, req, res, next);
    }
});

// Middleware for handling errors
app.use((err, req, res, next) => {
    handleError(err, req, res, next);
});

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

Sending Responses

app.get('/data', (req, res, next) => {
    const data = { key: 'value' };
    const status = new Status(200, 'Success', 'Data fetched successfully');
    sendResponse(req, res, next, data, status);
});

Pagination

app.get('/items', (req, res, next) => {
    const items = [{ id: 1 }, { id: 2 }];
    const status = new Status(200, 'Success', 'Items fetched successfully');
    const pagination = new Pagination('id', 'asc', 2, 10, 1, false);
    sendResponse(req, res, next, items, status, pagination);
});

Classes

NoResponseError

This class represents an error that occurs when there is no response.

class NoResponseError extends Error {
    constructor(status = 500, message = ERROR_MESSAGES.INTERNAL_SERVER_ERROR_500, description = ERROR_MESSAGES.CONTACT_ADMINISTRATOR) {
        super(message);
        this.message = message;
        this.status = status;
        this.description = description;
    }
}

ServerError

This class represents a server-side error.

class ServerError extends Error {
    constructor(status = 500, message = ERROR_MESSAGES.INTERNAL_SERVER_ERROR_500, description = ERROR_MESSAGES.CONTACT_ADMINISTRATOR) {
        super(message);
        this.message = message;
        this.status = status;
        this.description = description;
    }
}

ClientError

This class represents a client-side error.

class ClientError extends Error {
    constructor(status, message, description = '') {
        super(message);
        this.message = message;
        this.status = status;
        this.description = description;
    }
}

Status Class

The Status class represents the status of a response.

class Status {
    constructor(code = 200, message = '', description = '') {
        this.code = code;
        this.message = message;
        this.description = description;
    }
}

Pagination Class

The Pagination class provides pagination support for responses.

class Pagination {
    constructor(sortColumn, sortDirection = 'asc', total = 1, pageSize = 10, pageIndex = 1, hasMore) {
        this.sortColumn = sortColumn;
        this.sortDirection = sortDirection;
        this.total = total;
        this.pageSize = pageSize;
        this.pageIndex = pageIndex;
        if (hasMore != null) {
            this.hasMore = hasMore;
        }
    }
}

Functions

handleError

The handleError function logs the error and sends a response with the appropriate status and message.

sendResponse

The sendResponse function sends a structured response.

License

This project is licensed under the MIT License