com.hydroper.ftl

TypeScript Fluent Translation List

Rapidly support Fluent Translation Lists in your web application. This uses the NPM package @fluent/bundle.

Both client-side and server-side applications are supported.

Getting Started

Install dependency:

npm install com.hydroper.ftl

Example TypeScript:

import { FTL } from 'com.hydroper.ftl';

class Main {
    ftl: FTL;

    constructor() {
        this.ftl = new FTL({
            supportedLocales: ['en'],
            fallbacks: {
                // 'pt-BR': ['en'],
            },
            defaultLocale: 'en',

            assetSource: 'res/lang',
            assetFiles: [
                '_', // res/lang/LANG/_.ftl
            ],

            cleanUnusedAssets: true,

            // specify either 'http' or 'fileSystem' as load method
            loadMethod: 'fileSystem',
        });
        this.initialize();
    }

    async initialize() {
        if (!(await this.ftl.load())) {
            // failed to load
            return;
        }

        console.log(this.ftl.getMessage('hello', { to: 'Jessica' }));
    }
}

new Main();

Example FTL at res/lang/en/_.ftl:

hello = Hello, { $to }!

Server Usage

Usually, for server applications, set the cleanUnusedAssets option to false and clone the FTL object when necessary by invoking ftl.clone(); to change the current locale.

The ftl.clone(); method clones the FTL object, but still re-uses resources from the original object, avoiding resource duplication.

API

Currently no TypeDocs generated, but you can consult the API at: index.d.ts.