---
title: طرز استفاده
description: عملیات پایهٔ تعریف کلاس خطا، ثبت پیام، جابه‌جایی زبان، prefix و fallback.
---

## روند پایه [#basic-flow]

1. **تعریف کلاس خطا**

    از `I18nErrorBase<TMeta>` ارث ببرید و اطلاعات ساخت پیام را در `TMeta` تعریف کنید.

2. **ثبت پیام هر زبان**

    پیام هر کلاس و زبان را با `setErrorMessage` ثبت کنید.

3. **جابه‌جایی زبان و خواندن message**

    با `setGlobalConfig({ lang })` جابه‌جا کنید و `error.message` را بخوانید.

```ts
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
```

## تعریف کلاس خطا [#define-error-class]

`TMeta` اطلاعات همراه برای ساخت پیام است. در `error.meta` نگه داشته می‌شود و به تابع‌های ثبت‌شده سپرده می‌شود.

```ts
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` است.

```ts
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` را حذف کرد.

```ts
class NoMetaError extends I18nErrorBase<undefined> {}

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

:::note
مستقیم `new` نکنید؛ همیشه ارث ببرید. ثبت به‌ازای هر کلاس است، پس ثبت والد به فرزند نمی‌رسد.
:::

## ثبت پیام [#register-message]

`setErrorMessage` تابع‌های سازندهٔ پیام هر کلاس و زبان را ثبت می‌کند.

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

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

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

رشته هم مجاز است. زبان‌ها را می‌توان به‌صورت آرایه مشخص کرد.

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

ثبت دوبارهٔ همان کلاس و زبان بازنویسی می‌شود. فقط وقتی سازندهٔ زمان ثبت و رجوع یکسان باشد به کار می‌رود، نه با `instanceof`.

:::warning[توجه به دسترسی پیش از ثبت]
خواندن زودهنگام `message` مقدار پیش‌فرض را تثبیت می‌کند. پیش از ساخت نمونه ثبت کنید.
:::

## جابه‌جایی زبان [#switch-language]

با تنظیم سراسری Valibot جابه‌جا کنید. `message` در هر خواندن به `lang` جاری رجوع می‌کند.

```ts
import { setGlobalConfig } from "valibot";

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

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

`lang` تنظیم‌نشده `"en"` است. زبان‌های ثبت‌نشده از پیام پیش‌فرض سازنده استفاده می‌کنند.

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

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

## افزودن پیشوند [#prefix]

`static prefix` به ابتدای پیام حل‌شده افزوده می‌شود. هم روی ترجمه‌شده و هم پیش‌فرض اعمال می‌شود.

```ts
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-behavior]

- `error instanceof Error` و `instanceof I18nErrorBase` و `instanceof` کلاس عینی هر سه `true` است
- `String(error)` / `error.toString()` پیام حل‌شده را در بر دارد (مثلاً `"Error: ..."`)
- `cause` با `{ cause }` نگه داشته می‌شود

## الگوهای رایج [#common-patterns]

### تثبیت پیام پیش‌فرض در سازنده [#fix-default-message-in-constructor]

```ts
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` می‌سپارد و از تکرار متن پیش‌فرض جلوگیری می‌شود.

### ثبت یکجای چند زبان [#register-multiple-languages]

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

کدهای زبان نرمال‌سازی نمی‌شوند. `"en"` و `"en-US"` کلیدهای جدا هستند، پس کدهای لازم را صریح ثبت کنید.