https://github.com/outofsyncstudios/localize

A basic i18n module for Node.JS
https://github.com/outofsyncstudios/localize

i18n javascript nodejs npm open-source

Last synced: 6 days ago
JSON representation

A basic i18n module for Node.JS

• Host: GitHub
• URL: https://github.com/outofsyncstudios/localize
• Owner: OutOfSyncStudios
• License: mit
• Created: 2019-02-04T20:01:58.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2023-03-11T00:01:33.000Z (over 1 year ago)
• Last Synced: 2024-11-03T05:33:15.414Z (13 days ago)
• Topics: i18n, javascript, nodejs, npm, open-source
• Language: JavaScript
• Homepage:
• Size: 371 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# localize

[![NPM](https://nodei.co/npm/@outofsync/localize.png?downloads=true)](https://nodei.co/npm/@outofsync/localize/)

[![Actual version published on npm](http://img.shields.io/npm/v/@outofsync/localize.svg)](https://www.npmjs.org/package/@outofsync/localize)

[![Total npm module downloads](http://img.shields.io/npm/dt/@outofsync/localize.svg)](https://www.npmjs.org/package/@outofsync/localize)

[![Codacy Badge](https://app.codacy.com/project/badge/Grade/70cd43a66ab94c5494c98f473a81f960)](https://www.codacy.com/gh/OutOfSyncStudios/localize/dashboard?utm_source=github.com&utm_medium=referral&utm_content=OutOfSyncStudios/localize&utm_campaign=Badge_Grade)

[![Codacy Coverage Badge](https://app.codacy.com/project/badge/Coverage/70cd43a66ab94c5494c98f473a81f960)](https://www.codacy.com/gh/OutOfSyncStudios/localize/dashboard?utm_source=github.com&utm_medium=referral&utm_content=OutOfSyncStudios/localize&utm_campaign=Badge_Coverage)

[![Dependencies badge](https://david-dm.org/OutOfSyncStudios/localize/status.svg)](https://david-dm.org/OutOfSyncStudios/localize?view=list)

`localize` is a basic i18n module for Node.JS.

# [Installation](#installation)



```shell

npm install @outofsync/localize

```

# [Usage](#usage)



```js

const Localize = require('@outofsync/localize');

const i18n = new Localize({

  'en': {

    'TestKey': 'Test'

  },

  'es': {

    'TestKey': 'Prueba'

  }

});

console.log(i18n.tr('TestKey'));

```

# [API Reference](#api)



## Localize constructor(dictionaries, defaultLang) ⟾ instanceof Localize

Create an instance of Localize with the dictionaries provided and using the default language. If no default language is provided then `'en'` will be used.

## Localize isLanguageAvailable(lang) ⟾ boolean

Returns a boolean regarding the availability of a dictionary for the provided `lang`.

## Localize sanitizeLanguageCode(lang) ⟾ string

Sanitizes a the `lang` provided to only the first two characters of a string. If a non-string value for `lang` is provided then `'en'` is returned.

## Localize setDefaultLanguage(lang) ⟾ string

Sets the default language to the `lang` provided after sanitization. If no dictionary for the `lang` is available, then an error is thrown.

## Localize listLanguages ⟾ Array

Returns an Array of the available dictionary languages.

## Localize loadDictionary(lang, dictionary)

Loads and overwrites dictionary entries for the given `lang`. Existing key values are overwritten by values loaded.

## Localize tr(key, lang, ...params) ⟾ string | object | null

Returns the translations provided for a given key of the `lang` provided, or a map of the dictionary for the top level key. If no `lang` is provided or is not available, then the default language is used. If the key does not exist in the dictionary, then a `null` value is returned. Additional parameters may be passed and they are replaced in the translated string in the order they appear where '$1', '$2', etc... appear in strings.

# [License](#license)



Licensed under the MIT license.

Copyright (c) 2019-2022 Out of Sync Studios LLC