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

ym-error-code

v1.0.0

Published

Http error codes with names and messages

Downloads

2

Readme

ym-error-code v1.0.0

REST API Error Messages Generator - Module to automate and standardize error messages on REST API based services.

Installation

$ npm i ym-error-code --save

Implementation

Adding New Error

You can add your custom error codes on the class instantiation.

//Import
import ErrorGenerator from "ym-error-code";

//Instantiation, with new error codes
const Error = new ErrorGenerator({
	"1": {
    "code": 1,
    "details": "New Error",
    "message": {
      "en": "Your new error message",
      "my": "သီဟိုဠ်မှ ဉာဏ်ကြီးရှင်သည် အာယုဝဍ္ဎနဆေးညွှန်းစာကို ဇလွန်ဈေးဘေး ဗာဒံပင်ထက် အဓိဋ္ဌာန်လျက် ဂဃနဏဖတ်ခဲ့သည်။"
    }
  },
	"2": {
    "code": 2,
    "details": "New Error 2",
    "message": {
      "en": "Your new error message 2",
      "my": "သီဟိုဠ်မှ ဉာဏ်ကြီးရှင်သည် အာယုဝဍ္ဎနဆေးညွှန်းစာကို ဇလွန်ဈေးဘေး ဗာဒံပင်ထက် အဓိဋ္ဌာန်လျက် ဂဃနဏဖတ်ခဲ့သည်။"
    }
  },
});

Error.getMessage(1);

/* will return	
	{
		"code": 1,
		"details": "New Error",
		"message": "Your new error message"
	}
*/

Warning: If your new error code are the same with the existing error code, the existing error code will be overridden.

Internationalization

By default, ym-error-code message comes with English (United States) locale strings. If you need other locales, pass the key and the string value on the class instantiation.

//Import
import ErrorGenerator from "ym-error-code";

//Instantiation, english by default
const Error =  new ErrorGenerator();

//Instantiation with Burmese as default language
const Error =  new ErrorGenerator(null, 'my');

//pass the locale string
Error.setLanguage('my');

Note: Currently, the ​​available languages for displaying error messages are English ('en') and Myanmar ('my').

Basic usage


Error.getMessage(200);

/* will return	
	{
		"code": 200,
		"details": "Ok",
		"message": "Request has successfully been completed."
	}
*/

Using Custom Error Message

You can change the error message with your custom message.


Error.getCustomMessage(200, 'Your custom message');

/* will return	
	{
		"code": 200,
		"details": "Ok",
		"message": "Your custom message"
	}
*/