Použitie

Definícia chybových tried, registrácia správ, prepínanie jazykov, prefix a základné operácie 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

Definícia chybovej triedy

TMeta sú pomocné údaje na generovanie správy. Uchovávajú sa v error.meta a odovzdávajú sa registrovaným funkciá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 reťazec alebo funkcia (meta) => string. Tretí sú voľby Error, napr. { 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

Ak nastavíte TMeta na undefined, možno meta vynechať.

class NoMetaError extends I18nErrorBase<undefined> {}

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

Registrácia správy

setErrorMessage registruje funkcie na tvorbu správy pre triedu 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");

Reťazce sú povolené tiež. Jazyky možno zadať ako pole.

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

Opätovná registrácia rovnakej triedy a jazyka hodnotu prepíše. Platí len pre zhodné konštruktory pri registrácii a pri prístupe, nie cez instanceof.

Prepínanie jazyka

Prepnite v globálnom nastavení Valibotu. message pri každom čítaní zohľadňuje aktuálne 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ú predvolenú správu z konštruktora.

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

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

Predpona

static prefix sa pripojí na začiatok vyhodnotenej správy. Platí pre preložené aj predvolené sprá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"

Ak nie je nastavená, vracia sa bez zmeny.

Správanie ako Error

• error instanceof Error, instanceof I18nErrorBase aj instanceof konkrétnej triedy sú vo všetkých prípadoch true
• String(error) / error.toString() obsahujú vyhodnotenú správu (napr. "Error: ...")
• cause sa uchováva cez { cause }

Bežné vzory

Fixácia predvolenej správy v konštruktore

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úca strana potom pracuje len s meta a vyhne sa duplicite predvoleného textu.

Hromadná registrácia viacerých jazykov

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

Kódy jazykov sa nenormalizujú. "en" a "en-US" sú odlišné kľúče, preto potrebné kódy registrujte explicitne.