Utilização

Operações básicas de definição de classes de erro, registo de mensagens, mudança de idioma, prefixos e recurso.

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

Definir a classe de erro

TMeta é informação auxiliar para gerar mensagens. É guardada como error.meta e passada às funções registadas.

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 cadeia de caracteres 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 TMeta for undefined, o meta pode ser omitido.

class NoMetaError extends I18nErrorBase<undefined> {}

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

Registar mensagens

setErrorMessage regista funções de criação 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");

Cadeias de caracteres também são aceites. Os idiomas podem ser indicados como vetores.

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

Voltar a registar a mesma classe e idioma substitui. Só se aplica quando os construtores de registo e de consulta coincidem, não por instanceof.

Mudar de idioma

O idioma muda-se na configuração global do Valibot. A message consulta o lang atual em cada acesso.

import { setGlobalConfig } from "valibot";

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

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

Sem lang definido, é "en". Idiomas sem registo usam a mensagem por omissão do construtor.

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

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

Adicionar um prefixo

static prefix é anteposto à mensagem resolvida. Aplica-se tanto às traduzidas como à mensagem por omissã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 for definido, é devolvido 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

Fixar a mensagem por omissã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 meta, evitando duplicar o texto por omissão.

Registar vários idiomas em conjunto

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

Os códigos de idioma não são normalizados. "en" e "en-US" são chaves distintas, por isso registe explicitamente os códigos necessários.