Użycie

Podstawowe operacje definiowania klas błędów, rejestrowania komunikatów, przełączania języków, prefiksów i fallbacku.

Podstawowy przepływ

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

Definiowanie klasy błędu

TMeta to dane pomocnicze do generowania komunikatu. Są przechowywane w error.meta i przekazywane do zarejestrowanych funkcji.

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

Drugi argument to ciąg lub funkcja (meta) => string. Trzeci to opcje Error, np. { 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

TMeta ustawione na undefined pozwala pominąć meta.

class NoMetaError extends I18nErrorBase<undefined> {}

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

Rejestrowanie komunikatów

setErrorMessage rejestruje funkcje tworzące komunikat dla klasy i języka.

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

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

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

Dozwolone są też ciągi. Języki można podać jako tablicę.

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

Ponowna rejestracja tej samej klasy i języka nadpisuje wpis. Dotyczy tylko zgodnych konstruktorów przy rejestracji i odczycie, nie przez instanceof.

Przełączanie języków

Przełącz w globalnej konfiguracji Valibot. message odwołuje się do bieżącego lang przy każdym odczycie.

import { setGlobalConfig } from "valibot";

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

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

Nieustawiony lang to "en". Niezarejestrowane języki używają domyślnego komunikatu z konstruktora.

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

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

Dodawanie prefiksu

static prefix jest dodawany na początku rozwiązanego komunikatu. Dotyczy komunikatów tłumaczonych i domyślnych.

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"

Gdy nie jest ustawiony, zwracany jest bez zmian.

Zachowanie jako Error

• error instanceof Error, instanceof I18nErrorBase i instanceof <klasa konkretna> zwracają true
• String(error) / error.toString() zawierają rozwiązany komunikat (np. "Error: ...")
• cause jest przechowywane przez { cause }

Typowe wzorce

Ustalenie komunikatu domyślnego w konstruktorze

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

Strona wywołująca przekazuje tylko meta, co pozwala uniknąć powielania domyślnego tekstu.

Rejestrowanie wielu języków naraz

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

Kody języków nie są normalizowane. "en" i "en-US" to osobne klucze, więc zarejestruj jawnie potrzebne kody.