intlayer Elysia Eklenti Dokümantasyonu

Elysia için intlayer eklentisi kullanıcının locale'ini tespit eder ve route context'ine bir intlayer nesnesi enjekte eder. Ayrıca, istek bağlamı içerisinde global çeviri fonksiyonlarının kullanılmasını sağlar.

Kullanım

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

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

Aynı helper'lar bağımsız export'lar olarak da mevcuttur; böylece route context'ini destructure etmeden çağırabilirsiniz:

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

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

Açıklama

Eklenti aşağıdaki görevleri yerine getirir:

1. Locale Algılama: İstemcinin açıkça belirlediği locale'i storage'dan (çerez, başlık) okur, ardından Accept-Language başlığından müzakere edilen locale'e geri döner.
2. Bağlama Enjeksiyon: Elysia route context'ine intlayer özelliğini ekler; bu özellik şunları içerir:
   • locale: Bu istek için kullanılacak locale; locale_storage, locale_detected'a göre önceliklidir.
   • locale_storage: İstemcinin bir çerez veya başlık aracılığıyla açıkça talep ettiği locale.
   • locale_detected: İstek başlıklarından müzakere edilen locale.
   • defaultLocale: intlayer.config.ts içinde fallback olarak yapılandırılan locale.
   • t: Bir çeviri fonksiyonu.
   • getIntlayer: Sözlükleri anahtarına göre almak için bir fonksiyon.
   • getDictionary: Sözlük nesnelerini işlemek için bir fonksiyon.
3. Bağlam Yönetimi: Asenkron bir bağlamı yönetmek için AsyncLocalStorage kullanır; böylece global Intlayer fonksiyonları (t, getIntlayer, getDictionary) bağlam nesnesini taşımaya gerek kalmadan isteğe özel locale'e erişebilir.

Node tabanlı Intlayer eklentilerinin aksine, elysia-intlayer cls-hooked yerine AsyncLocalStorage'a dayanır; çünkü cls-hooked, Bun'un uygulamadığı async_hooks.createHook'a bağımlıdır.

İstek bağlamı, yanıt map'lendiği anda serbest bırakılır; böylece bağımsız helper'lar hiçbir zaman sonlanmış bir isteğe karşı çözümlenmez. Eklentinin işlediği bir isteğin dışında çağrıldıklarında, yapılandırılmış varsayılan locale'e geri dönerler.

Yapılandırma

Eklenti intlayer.config.ts dosyanızı okur. Locale algılama için kullanılan çerezi ve başlığı özelleştirebilirsiniz:

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

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

export default config;

Yapılandırma hakkında daha fazla bilgi için yapılandırma dokümantasyonunu ziyaret edin.