Uso

Definición de clases de error, registro de mensajes, cambio de idioma, `prefix` y operaciones básicas de reserva (fallback).

Flujo básico

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

Definir la clase de error

TMeta es información auxiliar para generar mensajes. Se conserva como error.meta y se pasa a las funciones registradas.

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 segundo argumento es una cadena o una función (meta) => string. El tercero admite { cause } y otras opciones 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 es undefined, se puede omitir meta.

class NoMetaError extends I18nErrorBase<undefined> {}

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

Registrar mensajes

setErrorMessage registra funciones creadoras por clase e 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");

También se admiten cadenas. Los idiomas pueden indicarse como arreglos.

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

Volver a registrar la misma clase e idioma sobrescribe. Solo se aplica cuando coinciden los constructores de registro y de referencia, no por instanceof.

Cambiar el idioma

El idioma se cambia con la configuración global de Valibot. message consulta el lang actual en cada acceso.

import { setGlobalConfig } from "valibot";

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

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

Sin lang configurado, es "en". Los idiomas no registrados usan el mensaje predeterminado del constructor.

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

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

Añadir un prefijo

static prefix se antepone al mensaje resuelto. Se aplica tanto a los traducidos como al predeterminado.

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 se configura, se devuelve tal cual.

Comportamiento como Error

• Tanto error instanceof Error como instanceof I18nErrorBase e instanceof de la clase concreta son true.
• String(error) / error.toString() incluyen el mensaje resuelto (p. ej.: "Error: ...").
• cause se conserva con { cause }.

Patrones comunes

Fijar el mensaje predeterminado en el 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);
  }
}

Quien llama solo pasa meta y evita duplicar el texto predeterminado.

Registrar varios idiomas a la vez

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

No se normalizan los códigos de idioma. "en" y "en-US" son claves distintas, así que registre explícitamente los códigos necesarios.