Використання

Визначення класу помилок, реєстрація повідомлень, перемикання мови, 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" — окремі ключі, тому потрібні коди реєструйте явно.