Использование

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

Основной процесс

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 — вспомогательные данные для генерации сообщений. Хранится в 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" — разные ключи, поэтому нужные коды регистрируйте явно.