mysql-error-keys v0.1.3

mysql-error-keys

A list of name keys (string, not number) of MySQL error messages.

MySQL has lots of error messages, and it makes you to handle many raw key strings or code numbers in your coding. Here is an example.

authController.signUp({name, email, pwd}).then((res)=>{
    console.log("success!");
}).catch((err)=>{
    if(err.response.data.code === "ER_DUP_ENTRY"){ // this is raw string :(
        console.log("error: email duplicated!");
        return;
    }
});

As you can see, the code uses raw string "ER_DUP_ENTRY". It is not good for coding style and quality.

If you use this list, you can handle error keys as predefined constants to avoid bugs and for better coding style, and you can experience autocomplete of the list in editor of IDEs like Visual Studio Code and JetBrains WebStorm.

Install

$ npm install --save mysql-error-keys

or

$ yarn add mysql-error-keys

Usage

Using Import

import { mek } from 'mysql-error-keys';

authController.signUp({name, email, pwd}).then((res)=>{
    console.log("success!");
}).catch((err)=>{
    if(err.response.data.code === mek.ER_DUP_ENTRY){
        console.log("error: email duplicated!");
        return;
    }
});

or

import { ER_DUP_ENTRY } from 'mysql-error-keys';

authController.signUp({name, email, pwd}).then((res)=>{
    console.log("success!");
}).catch((err)=>{
    if(err.response.data.code === ER_DUP_ENTRY){
        console.log("error: email duplicated!");
        return;
    }
});

Using Require

const mek = require('mysql-error-keys')
authController.signUp({name, email, pwd}).then((res)=>{
    console.log("success!");
}).catch((err)=>{
    if(err.response.data.code === mek.ER_DUP_ENTRY){
        console.log("error: email duplicated!");
        return;
    }
});

or

const { ER_DUP_ENTRY } = require('mysql-error-keys')

authController.signUp({name, email, pwd}).then((res)=>{
    console.log("success!");
}).catch((err)=>{
    if(err.response.data.code === ER_DUP_ENTRY){
        console.log("error: email duplicated!");
        return;
    }
});

Error Message Reference

MySQL Error Message Reference

Please Be a Contributor !

As you know, this module always should be same as the latest version of MySQL Error Messages. MySQL Error Messages might be updated and I might miss it.

So if you find an issue, please feel free to make a pull request and an issue.

GitHub Repository: https://github.com/prettyblueberry/mysql-error-keys

License

MIT