Употреба

Основни операции за дефиниране на класове за грешки, регистриране на съобщения, превключване на езици, префикси и резервен вариант.

Основен поток

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

Дефиниране на клас за грешки

TMeta е помощна info за генериране на съобщения. Съхранява се в error.meta и се подава на регистрираните функции.

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

Вторият аргумент е низ или функция (meta) => string. Третият е { cause } и други Error опции.

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

При TMeta като undefined можете да пропуснете meta.

class NoMetaError extends I18nErrorBase<undefined> {}

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

Регистриране на съобщения

setErrorMessage регистрира фабрични функции по клас и език.

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

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

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

Низовете също са допустими. Езиците могат да се задават като масив.

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

Повторното регистриране на същия клас и език презаписва. Важи само когато конструкторите при регистрация и търсене съвпадат, не чрез instanceof.

Превключване на езици

Превключвайте чрез глобалната конфигурация на Valibot. message се отнася към текущия lang при всеки достъп.

import { setGlobalConfig } from "valibot";

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

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

Незададеният lang е "en". Нерегистрираните езици използват съобщението по подразбиране от конструктора.

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

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

Добавяне на префикс

static prefix се добавя в началото на разрешеното съобщение. Важи и за преведените, и за съобщенията по подразбиране.

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"

Когато не е зададен, връща се както е.

Поведение като Error

• error instanceof Error, instanceof I18nErrorBase и instanceof на конкретен клас са все true
• String(error) / error.toString() включват разрешеното съобщение (напр. "Error: ...")
• cause се пази чрез { cause }

Често срещани модели

Фиксиране на съобщението по подразбиране в конструктора

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

Извикващите подават само meta, което избягва дублирането на текста по подразбиране.

Регистриране на няколко езика наведнъж

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

Езиковите кодове не се нормализират. "en" и "en-US" са отделни ключове, затова регистрирайте изрично нужните кодове.