1.1.0 • Published 8 years ago

ntranslate v1.1.0

Weekly downloads
7
License
ISC
Repository
github
Last release
8 years ago

ntranslate - Internationalization Library for Node

A small library providing internationalization like ngx-translate for Node. (Use JSON Format)

Installation

npm install ntranslate --save

Usage

  • First you need to create a default language file in your application (ApplicationPath/lang/{{DefaultLang}}.json)
  • After that you can use the library

Methods

  • setDefaultLang(lang: String) : Define default language.

  • use(lang: String) : Define selected language. If selected language is not available, it will use the default language.

  • returnFile(lang: String) : Define selected language. If selected language is not available, it will use the default language. Return JSON File Content.

  • getDefaultLang() : Get default language.

  • getSelectedLang() : Get selected language.

  • translate(key: String, data: Array) : Translate string with selected language. Replace Translated string with value if data is defined.

  • translateParam(translateParam: Object(JSON), key: String, data: Array) : Translate string with selected language. Replace Translated string with value if data is defined.

  • changePath(path: String) : Change languag file path. Default: ApplicationPath/lang/ Recommandation: Use path.join() to be compatible with Linux and Windows

Path for language file : ApplicationPath/lang/{{lang}}.json

Example

fr.json

{
  "Test":{
    "Example":{
      "Toto": "Je suis un exemple {{name}}"
    }
  }
}

en.json

{
  "Test":{
    "Example":{
      "Toto": "I'm an Example {{name}}"
    }
  }
}

index.js

var nstranslate = require('ntranslate');

//Change language folder path
ntranslate.changePath(process.cwd());

//Set to default language to english
ntranslate.setDefaultLang('en');

//Return "I'm an Example {{name}}"
ntranslate.translate("Test.Example.Toto");

//Return "I'm an Example Toto"
ntranslate.translate("Test.Example.Toto", {"name": "Toto"});

//
ntranslate.use('fr');

//Return "Je suis un exemple Toto"
ntranslate.translate("Test.Example.Toto", {"name": "Toto"});
1.1.0

8 years ago

1.0.3

8 years ago

1.0.2

8 years ago

1.0.1

8 years ago

1.0.0

8 years ago