Utilizzo

Operazioni di base per definire le classi di errore, registrare i messaggi, cambiare lingua, usare prefix e ripiego.

Flusso di base

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

Definire la classe di errore

TMeta è un’informazione ausiliaria per generare i messaggi. È conservata come error.meta e passata alle funzioni registrate.

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

Il secondo argomento è una stringa o una funzione (meta) => string. Il terzo accetta { cause } e altre opzioni di 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

Impostando TMeta su undefined, è possibile omettere meta.

class NoMetaError extends I18nErrorBase<undefined> {}

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

Registrare i messaggi

setErrorMessage registra funzioni di creazione per classe e lingua.

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

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

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

Sono ammesse anche le stringhe. Le lingue possono essere indicate come array.

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

Registrare di nuovo la stessa classe e lingua sovrascrive. Vale solo quando i costruttori di registrazione e di riferimento coincidono, non tramite instanceof.

Cambiare lingua

La lingua si cambia con la configurazione globale di Valibot. message consulta il lang corrente a ogni accesso.

import { setGlobalConfig } from "valibot";

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

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

Senza lang impostato vale "en". Le lingue non registrate usano il messaggio predefinito del costruttore.

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

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

Aggiungere un prefisso

static prefix è anteposto al messaggio risolto. Si applica sia ai messaggi tradotti sia a quello predefinito.

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 non impostato, viene restituito così com’è.

Comportamento come Error

• Sia error instanceof Error sia instanceof I18nErrorBase e instanceof della classe concreta sono true.
• String(error) / error.toString() includono il messaggio risolto (ad es. "Error: ...").
• cause è conservato tramite { cause }.

Pattern comuni

Fissare il messaggio predefinito nel costruttore

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

Il chiamante passa solo meta, evitando di duplicare il testo predefinito.

Registrare più lingue insieme

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

I codici lingua non vengono normalizzati. "en" e "en-US" sono chiavi distinte, quindi registrare esplicitamente i codici necessari.