Použití

Definice chybových tříd, registrace zpráv, přepínání jazyků, prefix a základní operace fallbacku.

Základní postup

import { setGlobalConfig } from "valibot";
import { I18nErrorBase, setErrorMessage } from "i18n-error-base";

class BusinessRuleError extends I18nErrorBase<{ code: string; limit: number }> {
  public constructor(meta: { code: string; limit: number }) {
    super(meta, ({ code, limit }) => `Code: ${code}, Limit: ${limit}`);
  }
}

setErrorMessage(
  BusinessRuleError,
  ({ code, limit }) => `コード: ${code}、制限: ${limit}`,
  "ja",
);

const error = new BusinessRuleError({ code: "ERR", limit: 50 });

setGlobalConfig({ lang: "ja" });
console.log(error.message); // コード: ERR、制限: 50

setGlobalConfig({ lang: "en" });
console.log(error.message); // Code: ERR, Limit: 50

Definice chybové třídy

TMeta jsou pomocné údaje pro generování zprávy. Uchovávají se v error.meta a předávají se registrovaným funkcím.

import { I18nErrorBase } from "i18n-error-base";

class NotFoundError extends I18nErrorBase<{ resource: string }> {}

const error = new NotFoundError({ resource: "user" }, "fallback message");
console.log(error.meta); // { resource: "user" }

Druhý argument je řetězec nebo funkce (meta) => string. Třetí jsou volby Error, např. { cause }.

class TestError extends I18nErrorBase<{ code: string }> {}

const cause = new Error("original");
const error = new TestError({ code: "ERR" }, "something went wrong", { cause });
console.log(error.cause === cause); // true

Pokud nastavíte TMeta na undefined, lze meta vynechat.

class NoMetaError extends I18nErrorBase<undefined> {}

const a = new NoMetaError("no meta");
const b = new NoMetaError(undefined, "no meta");
console.log(a.meta); // undefined

Registrace zprávy

setErrorMessage registruje funkce pro tvorbu zprávy pro třídu a jazyk.

import { I18nErrorBase, setErrorMessage } from "i18n-error-base";

class TestError extends I18nErrorBase<{ code: string }> {}

setErrorMessage(TestError, ({ code }) => `エラーコード: ${code}`, "ja");
setErrorMessage(TestError, "something went wrong", "en");

Řetězce jsou povoleny také. Jazyky lze zadat jako pole.

const message = ({ code }: { code: string }) => `エラーコード: ${code}`;
setErrorMessage(TestError, message, ["ja", "ko", "zh"]);

Opětovná registrace stejné třídy a jazyka hodnotu přepíše. Platí jen pro shodné konstruktory při registraci a při přístupu, ne přes instanceof.

Přepínání jazyka

Přepněte v globálním nastavení Valibotu. message při každém čtení zohledňuje aktuální lang.

import { setGlobalConfig } from "valibot";

setGlobalConfig({ lang: "ja" });
console.log(error.message); // 日本語の登録メッセージ

setGlobalConfig({ lang: "en" });
console.log(error.message); // 英語の登録メッセージ or 既定メッセージ

Nenastavené lang je "en". Neregistrované jazyky používají výchozí zprávu z konstruktoru.

setErrorMessage(BusinessRuleError, () => "日本語メッセージ", "ja");

setGlobalConfig({ lang: "fr" });
console.log(error.message); // "Code: ERR, Limit: 50"（既定メッセージ）

Předpona

static prefix se připojí na začátek vyhodnocené zprávy. Platí pro přeložené i výchozí zprávy.

class PrefixedError extends I18nErrorBase<{ code: string }> {
  static {
    this.prefix = "[ERROR] ";
  }
}

setErrorMessage(PrefixedError, ({ code }) => `code is ${code}`, "ja");
const error = new PrefixedError({ code: "ERR" }, "fallback");

setGlobalConfig({ lang: "ja" });
console.log(error.message); // "[ERROR] code is ERR"

setGlobalConfig({ lang: "en" });
console.log(error.message); // "[ERROR] fallback"

Není-li nastaven, vrací se beze změny.

Chování jako Error

• error instanceof Error, instanceof I18nErrorBase i instanceof konkrétní třídy jsou ve všech případech true
• String(error) / error.toString() obsahují vyhodnocenou zprávu (např. "Error: ...")
• cause se uchovává přes { cause }

Běžné vzory

Fixace výchozí zprávy v konstruktoru

class BusinessRuleError extends I18nErrorBase<{ code: string; limit: number }> {
  public constructor(meta: { code: string; limit: number }, options?: ErrorOptions) {
    super(meta, ({ code, limit }) => `Code: ${code}, Limit: ${limit}`, options);
  }
}

Volající strana pak pracuje pouze s meta a vyhne se duplikaci výchozího textu.

Hromadná registrace více jazyků

setErrorMessage(MyError, "エラーが発生しました", ["ja"]);
setErrorMessage(MyError, "An error occurred", ["en", "en-US"]);

Kódy jazyků se nenormalizují. "en" a "en-US" jsou odlišné klíče, proto potřebné kódy registrujte explicitně.