devRael1 / i18n

Simple and lightweight message localisation

❓ i18n

Simple and lightweight message localisation.

📥 Installation

To install the package, type the following command in your console:

npm i @devraelfreeze/i18n

🛠️ API

Values	Description
new I18n(default_locale, locales)	Create a new I18n instance
default_locale	The name of the default locale
locales	Object of localised messages

Values	Description
i18n.getLocale(locale)	Get a locale
locale	Locale name

Returns a function which calls getMessage using the given locale name (or the default).

Values	Description
i18n.getMessage(locale, message, ...args)	Get a message from a specifc locale, message, ...args
locale	Locale name
message	Dot notation string for the message
...args	Placeholders / Pluralisation

⬇️ Examples

const I18n = require('@devraelfreeze/i18n');
const i18n = new I18n('english', {
	english: {
		welcome: 'Hello, world'
	},
	french: {
        welcome: 'Bonjour tout le monde'
	}
});

/** Note: you should check if the locale exists in i18n.locales */
const french_i18n = i18n.getLocale('french'); // get locale
console.log(french_i18n('welcome')); // -> 'Bonjour tout le monde'

/** This code does exactly the same */
console.log(i18n.getMessage('french', 'welcome'));

🐛 Bugs Report

If you have any bugs, feel free to open an issue on Github Repository

If you want more support, you can contact me on Discord: devRael#0123

🗃️ Old Versions

If you want to use old version, you can use command

npm i @devraelfreeze/discordjs-pagination@<version>

📝 License

Copyright © 2022 devRael1
This project is MIT licensed.