tlbs
TypeScript icon, indicating that this package has built-in type declarations

1.1.2 • Public • Published

Translated Labels (TLBS)

Get custom translations to your app easily!

Installation and Initialization

  • Use npm i tlbs to install
  • First, import the libary...
import { tlbs } from 'tlbs';
  • Then initialize passing the language to use, an array with all languages to work and the path to save the json files.
const lbs = tlbs('en', ['en', 'es', 'fr'], 'path/to/save/files/json');

Usage guide

  • To CREATE or EDIT a label...
await lbs.insertOrEdit([
  {
    name: 'hello_world',
    values: {
      es: 'Hola Mundo',
      en: 'Hello World',
      fr: 'Salut Monde',
    },
  },
]);

Usage guide

  • To CREATE or EDIT multiple labels...
await lbs.insertOrEdit([
  {
    name: 'hello_world',
    values: {
      en: 'Hello World',
      es: 'Hola Mundo',
    },
  },
  {
    name: 'hello_world_2',
    values: {
      en: 'Hello World 2',
      fr: 'Salut Monde 2'
    },
  },
]);
  • To GET a specific label use...
await lbs.get('hello_world').then((label) => {
 // do all you want with label here
 // label is a string
});
  • To GET ALL use:
await lbs.getAll().then((labels) => {
  // do all you want with labels
  // labels is an object
});
  • To DELETE one...
await lbs.delete('hello_world');

Note: The name of the labels must be as another_name and not as another name or another-name. This will turn into a javascript object and json as well, those rules prevent the library from breaking.

Package Sidebar

Install

npm i tlbs

Weekly Downloads

1

Version

1.1.2

License

ISC

Unpacked Size

13.5 kB

Total Files

6

Last publish

Collaborators

  • makuttico