Korištenje

Osnovne operacije definiranja klase pogreške, registracije poruka, prebacivanja jezika, prefiksa i zamjenske poruke.

Osnovni tijek

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

Definiranje klase pogreške

TMeta je pomoćna info za generiranje poruke. Čuva se u error.meta i prosljeđuje registriranim funkcijama.

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

Drugi argument je string ili funkcija (meta) => string. Treći je { cause } i druge Error opcije.

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

Ako je TMeta undefined, meta se može izostaviti.

class NoMetaError extends I18nErrorBase<undefined> {}

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

Registracija poruke

setErrorMessage registrira tvorničke funkcije po klasi i jeziku.

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

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

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

Stringovi su također dopušteni. Jezici se mogu zadati kao polje.

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

Ponovna registracija iste klase i jezika prepisuje. Vrijedi samo kad se konstruktori pri registraciji i traženju podudaraju, ne putem instanceof.

Prebacivanje jezika

Prebacite Valibot globalnom postavkom. message se pri svakom čitanju odnosi na trenutni lang.

import { setGlobalConfig } from "valibot";

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

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

Nepostavljeni lang je "en". Neregistrirani jezici koriste zadanu poruku iz konstruktora.

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

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

Dodavanje prefiksa

static prefix dodaje se na početak razriješene poruke. Vrijedi i za prevedene i za zadane poruke.

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"

Kad nije postavljen, vraća se kakav jest.

Ponašanje kao Error

• I error instanceof Error, i instanceof I18nErrorBase, i instanceof konkretne klase su true
• String(error) / error.toString() uključuju razriješenu poruku (npr. "Error: ...")
• cause se čuva putem { cause }

Uobičajeni obrasci

Fiksiranje zadane poruke u konstruktoru

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

Pozivatelj prosljeđuje samo meta, pa se izbjegava dupliciranje zadanog teksta.

Skupna registracija više jezika

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

Jezični kodovi se ne normaliziraju. "en" i "en-US" su zasebni ključevi, pa potrebne kodove registrirajte izričito.