שימוש

הגדרת מחלקת שגיאה, רישום הודעות, החלפת שפה, prefix ופעולות fallback בסיסיות.

התהליך הבסיסי

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

הגדרת מחלקת שגיאה

TMeta הוא מידע עזר ליצירת ההודעה. הוא נשמר ב-error.meta ומועבר לפונקציות הרשומות.

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

הארגומנט השני הוא מחרוזת או פונקציה (meta) => string. השלישי הוא { cause } ואפשרויות 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

אם מגדירים את TMeta כ-undefined, ניתן להשמיט את meta.

class NoMetaError extends I18nErrorBase<undefined> {}

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

רישום הודעה

setErrorMessage רושם פונקציות יצירת הודעה לכל מחלקה ושפה.

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

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

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

מחרוזות מותרות גם כן. ניתן לציין שפות כמערך.

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

רישום חוזר לאותה מחלקה ושפה דורס. הוא חל רק כאשר הקונסטרקטורים ברישום ובהתייחסות זהים, לא דרך instanceof.

החלפת שפה

מחליפים באמצעות ההגדרה הגלובלית של Valibot. message מתייחס ל-lang העדכני בכל קריאה.

import { setGlobalConfig } from "valibot";

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

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

lang לא מוגדר הוא "en". שפות לא רשומות משתמשות בהודעת ברירת המחדל של הקונסטרקטור.

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

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

הוספת תחילית

static prefix מתווסף לתחילת ההודעה שנפתרה. הוא חל על המתורגמת ועל ברירת המחדל.

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"

אם לא מוגדר, מוחזר כמות שהוא.

התנהגות כ-Error

• error instanceof Error, instanceof I18nErrorBase ו-instanceof המחלקה הקונקרטית כולם true
• String(error) / error.toString() כוללים את ההודעה שנפתרה (לדוגמה: "Error: ...")
• cause נשמר באמצעות { cause }

דפוסים נפוצים

קיבוע הודעת ברירת המחדל בקונסטרקטור

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

הצד הקורא מעביר רק meta, ונמנעת כפילות של טקסט ברירת המחדל.

רישום מספר שפות יחד

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

לא מתבצע נרמול של קודי שפה. "en" ו-"en-US" הם מפתחות נפרדים, ולכן רשמו במפורש את הקודים הדרושים.