localized-http-messages v0.1.2

localized-http-messages

A simple package giving you translated http messages.

Known locales

• en (english)
• fr (français)

You can send me translations in your locale if you want it in the module!

Basic usage

const translator = require('localized-http-messages')

let tr = new translator('fr') // or a JS Object with translations
console.log( tr.getMessage(418) )
// > Je suis une théière

API

Constructor(String|JS Object)

The parameter is the locale to set. If no locale is set, it will fallback to en.

The behavior is the same than calling setLocale method.

setLocale(String|JS Object)

Set the current locale.

If the parameter is a String, the module will try to find it in the list of known locale. If the locale is not known, it is ignored.

If the parameter is a JS Object, the module will load the object as the current locale. The object must be formatted like this:

{
    code: "Message",
    code: "Message",
    etc.
}

Example:

{
    404: "Custom message when not found",
    418: "Custom message for teapot"
}

getMessage(Number|String)

Return the String of the code given in paramter.

If the code is not found in the current locale, it falls back to the previous locale set. If the code is not found in the previous locale, it falls back to en.

If the code is not found in any of the locales, it return the code as a String.

Example:

const translator = require('localized-http-messages')

let tr = new translator('fr')
tr.setLocale({
    404: 'Not found, sorry!'
})
console.log( tr.getMessage(404) )
// > Not found, sorry!
console.log( tr.getMessage(418) )
// > Je suis une théière
console.log( tr.getMessage(999) )
// > 999

List of known codes

Sources

• https://fr.wikipedia.org/wiki/Liste_des_codes_HTTP
• https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html
• https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml
• https://httpstatuses.com/
• https://www.loggly.com/blog/http-status-code-diagram/
• https://assiste.com/Codes_HTTP/index_01.html
• https://translate.google.com