Käyttö

Virheluokan määrittäminen, viestien rekisteröinti, kielen vaihtaminen, etuliite ja varaviestin perustoiminnot.

Perustyönkulku

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

Virheluokan määrittäminen

TMeta on viestin luomisen liitännäistiedot. Se säilytetään error.meta-ominaisuutena ja välitetään rekisteröidyille funktioille.

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

Rakentajan toinen argumentti on merkkijono tai (meta) => string -funktio. Kolmas on { cause } ja muut Error-valinnat.

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

Jos TMeta on undefined, meta voidaan jättää pois.

class NoMetaError extends I18nErrorBase<undefined> {}

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

Viestin rekisteröinti

setErrorMessage rekisteröi luokka- ja kielikohtaiset luontifunktiot.

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

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

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

Merkkijonot ovat myös sallittuja. Kielet voidaan antaa taulukkoina.

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

Saman luokan ja kielen uudelleenrekisteröinti korvaa. Sitä käytetään vain, kun rekisteröintihetken ja viittaushetken rakentaja täsmäävät, ei instanceof-tarkistuksella.

Kielen vaihtaminen

Vaihda kieli Valibotin globaalilla asetuksella. message viittaa senhetkiseen lang-arvoon jokaisella käyttökerralla.

import { setGlobalConfig } from "valibot";

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

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

Asettamaton lang on "en". Rekisteröimättömät kielet käyttävät rakentajan oletusviestiä.

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

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

Etuliite

static prefix liitetään ratkaistun viestin alkuun. Sitä sovelletaan sekä käännettyihin että oletusviesteihin.

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"

Jos sitä ei ole asetettu, viesti palautetaan sellaisenaan.

Käyttäytyminen Error-luokkana

• error instanceof Error, instanceof I18nErrorBase ja instanceof <konkreettinen luokka> ovat kaikki true
• String(error) / error.toString() sisältää ratkaistun viestin (esim. "Error: ...")
• cause säilytetään muodossa { cause }

Yleiset mallit

Oletusviestin kiinnittäminen rakentajassa

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

Kutsuja välittää vain meta-arvon, jolloin oletustekstin toisto vältetään.

Useiden kielten rekisteröinti kerralla

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

Kielikoodeja ei normalisoida. "en" ja "en-US" ovat eri avaimia, joten tarvittavat koodit on rekisteröitävä erikseen.