Пређи на садржај
i18n-error-base
Српски
Esc
↑↓навигација↵отвори⌘Jпреглед
На овој страници

Употреба

Основне операције дефинисања класе грешке, регистрације порука, промене језика, префикса и резервне поруке.

Основни ток

Дефинисање класе грешке

Наследите I18nErrorBase<TMeta> и дефинишите податке за генерисање поруке у TMeta.

Регистрација порука по језицима

Региструјте поруку за класу и језик помоћу setErrorMessage.

Промена језика и читање message

Промените са setGlobalConfig({ lang }) и прочитајте error.message.

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" су засебни кључеви, па потребне кодове региструјте изричито.

Да ли вам је ова страница помогла?