Quick Start

A self-contained example. Copy, paste, run.

1. Install

npm install ilingo

2. Create an instance

import {
    Ilingo, MemoryStore,
    defineCatalog, defineLocale, defineNamespace, defineTranslations, definePlural,
} from 'ilingo';

const ilingo = new Ilingo({
    store: new MemoryStore({
        data: defineCatalog([
            defineLocale('en', [
                defineNamespace('cart', [
                    defineTranslations({
                        greeting: 'Welcome, {{name}}!',
                        items: definePlural({
                            one: '{{count}} item in your cart',
                            other: '{{count}} items in your cart',
                        }),
                    }),
                ]),
            ]),
            defineLocale('de', [
                defineNamespace('cart', [
                    defineTranslations({
                        greeting: 'Willkommen, {{name}}!',
                        items: definePlural({
                            one: '{{count}} Artikel im Warenkorb',
                            other: '{{count}} Artikel im Warenkorb',
                        }),
                    }),
                ]),
            ]),
        ]),
    }),
    locale: 'en',
});

3. Translate

await ilingo.get({
    namespace: 'cart',
    key: 'greeting',
    data: { name: 'Peter' },
});
// "Welcome, Peter!"

await ilingo.get({
    namespace: 'cart',
    key: 'items',
    count: 3,
});
// "3 items in your cart"

await ilingo.get({
    namespace: 'cart',
    key: 'greeting',
    locale: 'de',
    data: { name: 'Peter' },
});
// "Willkommen, Peter!"

That's it. The same call works with a file-system store and in a Vue app — the API does not change.

Where to go next

• Catalog Design — the descriptor tree and the five define* helpers.
• Stores — the IStore port and how to write your own.
• Locales & Fallback — how pt-BR finds en automatically.
• Pluralization — plural nodes via definePlural.
• Formatters — {{value, number(...)}} and friends.