Uso

Operações básicas para definir a classe de erro, registrar mensagens, trocar de idioma, usar prefixo e fallback.

Fluxo 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

Definindo a classe de erro

TMeta é a informação extra para gerar a mensagem. Fica salva como error.meta e é passada para as funções 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" }

O segundo argumento é uma string ou uma função (meta) => string. O terceiro aceita { cause } e outras opções 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

Se você definir TMeta como undefined, pode omitir o meta.

class NoMetaError extends I18nErrorBase<undefined> {}

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

Registrando mensagens

setErrorMessage registra a função que cria a mensagem por classe 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");

Strings também valem. Dá para indicar o idioma como array.

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

Registrar de novo a mesma classe e idioma sobrescreve. Só vale quando o construtor do registro e o da leitura são o mesmo, não por instanceof.

Trocando de idioma

Você troca o idioma na configuração global do Valibot. message consulta o lang atual a cada acesso.

import { setGlobalConfig } from "valibot";

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

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

Sem lang configurado, é "en". Idioma sem registro usa a mensagem padrão do construtor.

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

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

Prefixo

static prefix vai no início da mensagem resolvida. Vale tanto para as traduzidas quanto para a padrão.

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"

Se não configurar, retorna como está.

Comportamento como Error

• error instanceof Error, instanceof I18nErrorBase e instanceof da classe concreta são todos true.
• String(error) / error.toString() incluem a mensagem resolvida (ex.: "Error: ...").
• cause é guardado com { cause }.

Padrões comuns

Fixando a mensagem padrão no construtor

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

Quem chama só passa o meta e evita duplicar o texto padrão.

Registrando vários idiomas de uma vez

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

Códigos de idioma não são normalizados. "en" e "en-US" são chaves diferentes, então registre todos os códigos que você precisa.