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

valid-response-hiteshfolio

v1.0.2

Published

A utility for handling API responses with consistent error and success messaging.

Downloads

33

Readme

Valid Response HiteshFolio

A utility for handling API responses with consistent error and success messaging. This package simplifies the process of sending structured responses in your Node.js applications.

Table of Contents

  1. Installation
  2. Usage
  3. Error Handling
  4. License
  5. Contributing
  6. Author

Installation

You can install the package using npm:

npm install valid-response-hiteshfolio

Usage

To use this package, you need to require it in your Node.js application. You can then use the provided functions to send error or success responses.

Importing the Package

For CommonJS:

const { resError, resSuccess } = require('valid-response-hiteshfolio');

For ES Modules:

import { resError, resSuccess } from 'valid-response-hiteshfolio';

Functions

resError(res, errors, message, dynamicStatus)

Sends an error response with a structured format.

Parameters:

  • res: The response object from your Express app.
  • errors: Additional error information.
  • message: Custom error message (optional).
  • dynamicStatus: Boolean indicating whether to adjust status based on the message (default: false).

Example

app.get('/api/some-route', (req, res) => {
    const errors = { field: 'exampleField' };
    return resError(res, errors, 'Unauthorized access', true);
});

resSuccess(res, data, message, dynamicStatus)

Sends a success response with a structured format.

Parameters:

  • res: The response object from your Express app.
  • data: The data to be returned in the response.
  • message: Custom success message (optional).
  • dynamicStatus: Boolean indicating whether to adjust status based on the data (default: false).

Example

app.post('/api/create-user', (req, res) => {
    const userData = { id: 1, name: 'John Doe' };
    return resSuccess(res, userData, 'User created successfully', true);
});

Error Handling

This package automatically logs errors to the console, allowing for easier debugging during development. Ensure to check your console for any logged error messages.

License

This package is licensed under the Apache-2.0 License.

Contributing

Contributions are welcome! Please submit a pull request or open an issue to discuss changes. Ensure to follow the coding standards and include relevant tests for new features.

Author

Hitesh Saini 🧩💻 GitHub | LinkedIn | Portfolio