Ús

Operacions bàsiques de definició de classes d'error, registre de missatges, canvi d'idioma, prefix i reserva.

Flux bàsic

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

Definiu una classe d’error

TMeta és la informació auxiliar per generar el missatge. Es conserva com a error.meta i es passa a les funcions registrades.

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

El segon argument del constructor és una cadena o una funció (meta) => string. El tercer és { cause } i altres opcions de 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

Si TMeta és undefined, podeu ometre meta.

class NoMetaError extends I18nErrorBase<undefined> {}

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

Registreu els missatges

setErrorMessage registra funcions de fàbrica per classe i idioma.

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

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

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

Les cadenes també són permeses. Els idiomes es poden indicar com a matrius.

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

El nou registre de la mateixa classe i idioma sobreescriu. Només s’aplica quan els constructors del registre i de la consulta coincideixen, no via instanceof.

Canvieu l’idioma

Canvieu amb la configuració global de Valibot. message consulta el lang actual a cada accés.

import { setGlobalConfig } from "valibot";

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

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

El lang no configurat és "en". Els idiomes sense registre utilitzen el missatge per defecte del constructor.

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

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

Afegeix un prefix

static prefix es posa al principi del missatge resolt. S’aplica tant als missatges traduïts com als per defecte.

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"

Si no es configura, es retorna tal qual.

Comportament com a Error

• error instanceof Error, instanceof I18nErrorBase i instanceof <classe concreta> són tots true
• String(error) / error.toString() inclouen el missatge resolt (p. ex. "Error: ...")
• cause es conserva amb { cause }

Patrons habituals

Fixeu el missatge per defecte al constructor

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

La part cridant només passa meta, evitant la duplicació del text per defecte.

Registreu diversos idiomes alhora

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

Els codis d’idioma no es normalitzen. "en" i "en-US" són claus diferents, de manera que registreu explícitament els codis necessaris.