Használat

Hibaosztályok definiálása, üzenetregisztráció, nyelvváltás, prefix és tartalék üzenet alapműveletei.

Alapfolyamat

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

Hibaosztály definiálása

A TMeta az üzenetgeneráláshoz használt kiegészítő adatok. error.meta néven tárolódik, és a regisztrált függvényeknek is átadódik.

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" }

A második argument sztring vagy (meta) => string függvény. A harmadik az Error opciói, például { 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

Ha a TMeta értéke undefined, a meta elhagyható.

class NoMetaError extends I18nErrorBase<undefined> {}

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

Üzenet regisztrálása

A setErrorMessage osztályhoz és nyelvhez tartozó üzenetkészítő függvényeket regisztrál.

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

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

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

A sztring is megadható. A nyelv tömbként is megadható.

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

Azonos osztály és nyelv újbóli regisztrálása felülírja a bejegyzést. Csak azonos regisztrációkori és hivatkozáskori konstruktor esetén érvényes, nem instanceof alapján.

Nyelvváltás

A nyelv a Valibot globális beállításával váltható. A message minden olvasáskor az aktuális lang értékre hivatkozik.

import { setGlobalConfig } from "valibot";

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

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

Beállítás hiányában a lang értéke "en". Nem regisztrált nyelv esetén a konstruktor alapértelmezett üzenete használatos.

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

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

Előtag hozzáadása

A static prefix a feloldott üzenet elejére fűződik. A lefordított és az alapértelmezett üzenetekre egyaránt vonatkozik.

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"

Beállítás hiányában változatlanul tér vissza.

Viselkedés Error típusként

• Az error instanceof Error, az instanceof I18nErrorBase és az instanceof konkrét osztály ellenőrzés mindegyike true
• A String(error) / error.toString() tartalmazza a feloldott üzenetet (pl. "Error: ...")
• A cause értéke { cause } segítségével tárolódik

Gyakori minták

Az alapértelmezett üzenet rögzítése a konstruktorban

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);
  }
}

A hívó oldalnak csak a meta értéket kell átadnia, így elkerülhető az alapértelmezett szöveg ismétlése.

Több nyelv együttes regisztrálása

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

A nyelvkódok normalizálása nem történik meg. Az "en" és az "en-US" külön kulcs, ezért a szükséges kódokat explicit módon regisztrálja.