intlayer Elysia Plugin Documentation

The intlayer plugin for Elysia detects the user's locale and injects an intlayer object into the route context. It also enables the use of the standalone translation functions within the request context.

Usage

import { Elysia } from "elysia";
import { intlayer } from "elysia-intlayer";

const app = new Elysia().use(intlayer()).get("/", ({ intlayer }) =>
  intlayer!.t({
    en: "Hello",
    fr: "Bonjour",
    es: "Hola",
  })
);

The plugin registers its context through a global derive, which Elysia types as Partial<{ intlayer: IntlayerContext }>. The value is always present at runtime for routes registered after .use(intlayer()), so use the non-null assertion (intlayer!.t), or optional chaining, to satisfy TypeScript in strict mode.

The same helpers are available as standalone exports, so you can call them without destructuring the route context:

import { Elysia } from "elysia";
import { intlayer, t } from "elysia-intlayer";

const app = new Elysia().use(intlayer()).get("/", () =>
  t({
    en: "Hello",
    fr: "Bonjour",
    es: "Hola",
  })
);

Description

The plugin performs the following tasks:

1. Locale Detection: It reads the locale explicitly set by the client from storage (cookie, header), then falls back to the locale negotiated from the Accept-Language header. If no supported locale matches, it falls back to the configured defaultLocale.
2. Context Injection: It adds an intlayer property to the Elysia route context (see the table below).
3. Dictionary Preparation: It calls prepareIntlayer when the plugin is created, so the dictionaries are built when the app boots.

Route Context

When called outside of a request handled by the plugin, the standalone helpers fall back to the configured default locale.

Locale Resolution Order

By default, the plugin resolves the locale in this order:

1. The INTLAYER_LOCALE cookie.
2. The x-intlayer-locale header.
3. The Accept-Language header negotiation.
4. The configured defaultLocale.

# Negotiated from `Accept-Language`
curl -H "Accept-Language: fr" http://localhost:3000/
# Bonjour

# The cookie takes precedence over `Accept-Language`
curl -H "Accept-Language: fr" -H "Cookie: INTLAYER_LOCALE=es" http://localhost:3000/
# Hola

# The header takes precedence over `Accept-Language`
curl -H "Accept-Language: fr" -H "x-intlayer-locale: es" http://localhost:3000/
# Hola

Configuration

The plugin reads your intlayer.config.ts file. You can customize the cookie and header used for locale detection:

import { Locales, type IntlayerConfig } from "intlayer";

const config: IntlayerConfig = {
  internationalization: {
    locales: [Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH],
    defaultLocale: Locales.ENGLISH,
  },
  routing: {
    storage: [
      { type: "header", name: "my-locale-header" },
      { type: "cookie", name: "my-locale-cookie" },
    ],
  },
};

export default config;

For more information on configuration, visit the configuration documentation.

Related Doc