Installation

npm install http-message-codes

Usage

``javascript
const error = require("http-message-codes");
// parameter could be any object (json), string or number
let lang = 'en' // -Optional, supported languages en ( English ), cz ( Traditional Chinese ) - default language cz
const { status, result } = error.SUCCESS(parameter, lang);
res.status(status).json(result);
console.log(status);
console.log(result);
``

HTTP CUSTOM ERROR CODES / MESSAGE

#### All functions ( SUCCESS, DB_ERROR_GET, etc) accept one optional parameter.

$3

| code | message (Chinese) | messge (English) |
|----------|--------------------------------|-----------------------------------------------------------------------|
| 0 | 成功 | Success |
| 16 | 資料取得錯誤 | Error while getting data from the database |
| 17 | 資料新增錯誤 | Error while posting data to the database |
| 18 | 資料修改錯誤 | Error while putting data to the database |
| 20 | 預期紀錄未在資料庫找到 | Record expected but nothing found on database |
| 24 | 紀錄未啟用、無效或未支的狀態 | Record not active, disabled or unknown status |
| 32 | 處理必要參數時錯誤 | Error while processing required parameter |
| 33 | 處理Json格式的參數時錯誤 | Error while processing json formatted parameter |
| 34 | 錯誤的電子信箱格式 | Wrong email format |
| 36 | 未知的或未支援的參數格式 | Unknown or unsupported parameter format |
| 40 | 檔案並未上傳 | File was not uploaded |
| 48 | 檔案類型未支援 | File type not supported |
| 64 | 參數值無效 | Parameter value is invalid |
| 65 | Token無效 | Token is invalid |
| 66 | Token已過期 | Token has expired |
| 96 | 只能選擇現金或點數交易 | Error trading, order must be paid all in cash or all in points |
| 128 | 移動檔案錯誤 | Error moving file |
| 160 | 現金不足 | Parameter cash is not enough to pay the order |
| 256 | 使用者名稱已被使用 | Username already in used |
| 257 | 拒絕訪問 | Access denied |
| 258 | 使用者已登入 | User has already login |
| 260 | 密碼過期 | Account password has expired and need to be reset |
| 264 | 登入錯誤, 鎖定中 | Account lock for a period of time |
| 288 | 檔案太大 | File size is too big |
| 1024 | 服務連結錯誤 | Error connecting to service |
| 1025 | 憑證授權錯誤 | Certificate authority error |
| 1026 | Google firebase 雲訊息傳送失敗 | Error sending message through Google firebase cloud messaging service |
| 1056 | 點數不足 | User does not have enough points to pay the order |
| 2048 | 未知的功能，此問題將會回報 | Unknown function, this issue will be reported |
| 2080 | 參數from和to只能輸入一個 | Only receiver or sender can be defined, not both |
| 4096 | 初始化使用者點數失敗 | Error initializing user's point (asset) |
| 4097 | 新增管理員點數失敗 | Error increasing admin points |
| 4098 | 新增使用者點數失敗 | Error transferring points |
| 4100 | 新增未簽名的交易提案失敗 | Error while creating transaction proposal |
| 4104 | 提交簽名的交易提案失敗 | Error while committing transaction proposal to the blockchain |
| 4112 | 傳送簽名的交易失敗 | Error while committing the transaction to the blockchain |

$3

> Error code table, bug fixes

$3

> Account lock for a period of time - 登入錯誤, 鎖定中
AUTHENTICATION_ACCOUNT_LOCKED

$3

> Account password has expired and need to be reset - 密碼過期
AUTHENTICATION_ACCOUNT_PASSWORD_EXPIRED

$3

> Not enough points to pay the order
PARAMETER_NOT_ENOUGH_POINTS

Can only define from or to, not both
>PARAMETER_ONLY_ONE_ALLOWED

$3

FILE_TO_BIG
>File size is too big, 打案太大

$3

>Bug fixed

$3

PARAMETER_CASH_OR_POINT
>Error trading, order must be paid all in cash or all in points,只能選擇現金或點數交易

PARAMETER_CASH
>Parameter cash is not enough to pay the order, 現金不足

SERVICE_FIREBASE
>Error connecting to service,服務連結錯誤

BLOCKCHAIN_POINT_INITIALIZE
>Error initializing user's point (asset),初始化使用者點數失敗

BLOCKCHAIN_POINT_INCREMENT
>Error increasing admin points,初始化使用者點數失敗

BLOCKCHAIN_POINT_TRANSFER
>Error transferring points,新增使用者點數失敗

BLOCKCHAIN_CREATE_TRANSACTION_PROPOSAL
>Error while creating transaction proposal,新增未簽名的交易提案失敗

BLOCKCHAIN_COMMIT_TRANSACTION_PROPOSAL
>Error while committing transaction proposal to the blockchain,提交簽名的交易提案失敗

BLOCKCHAIN_COMMIT_TRANSACTION
>Error while committing the transaction to the blockchain,傳送簽名的交易失敗

$3

> Missing the success in Chinese - bug

$3

> Add languages: en ( English ) & cz ( Traditional Chinese, default )

$3

DB_ERROR_WRONG_STATUS
> The record is disabled, inactive or unknown status

$3

UNKNOWN_FUNCTION_NAME
> The function the API is trying to access is known to one of the services

$3

TOKEN_ERROR_EXPIRED
> JWT Token has expired

$3

AUTHENTICATION_ALREADY_LOGIN
> Users has already been login, a new token will not be returned until user logout first.

$3

PARAMETER_INVALID
> A parameter value is invalid. Ex: role is only expecting values ranging from 0 to 3 but the value received is 4, then the parameter value is invalid. Please note that if the value received is a different format then please use PARAMETER_UNSUPPORTED_FORMAT

AUTHENTICATION_USERNAME_IN_USED
> A username has been already register

AUTHENTICATION_ACCESS_DENIED
> Access to a resource has been denied either by providing the wrong credentials or the wrong token

SERVICE_CONNECTION_ERROR
> A connection to a service has not been established or it has been broken.

SERVICE_CA_ERROR
> The certificate authority is returning an error. The error details could be added to the object

$3

DB_ERROR_NOT_FOUND
> A record was expected to be returned but nothing was return. If returning empty from database is possible, like in list API, then this is not the error code to use.

$3

PARAMETER_EMAIL_FORMAT
> Parameter is expected to have an email format

PARAMETER_UNSUPPORTED_FORMAT
> Parameter format is unknown or it is currently not supported

v 1.0.6

SUCCESS
> Request has been successful

DB_ERROR_GET
> Error while trying to get a record from the database

DB_ERROR_CREATE
> Error while trying to create a record in the database

DB_ERROR_UPDATE
> Error while trying to update a record in the database

PARAMETER_REQUIRED
> Required parameter not received

PARAMETER_JSON_FORMAT
> Error while trying to parse a json formatted variable

TOKEN_ERROR_INVALID
> Token is not valid

FILE_NOT_UPLOADED
> A file was not uploaded to the server

FILE_TYPE_NOT_SUPPORTED
> The uploaded file's type is not supported

OS_MOVE_FILE
> Error while moving the file to location