---
title: Referenční příručka API
description: Specifikace I18nErrorBase, setErrorMessage a souvisejících typů.
---

## `I18nErrorBase` [#i18n-error-base]

Základní třída pro dědění z `Error`. `message` se resolvuje podle `lang`.

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

class MyError extends I18nErrorBase<{ code: string }> {}
```

### Parametry typu [#type-params]

| Prop | Type | Default | Description |
| ---- | ---- | ------- | ----------- |
| `TMeta` | `ErrorMeta \| undefined` | `ErrorMeta \| undefined` | Typ `meta`. Když se nepoužívá, zadejte `undefined`. |

### Statické vlastnosti [#static-props]

| Prop | Type | Default | Description |
| ---- | ---- | ------- | ----------- |
| `prefix?` | `string` | `undefined` | Připojí se na začátek vyhodnocené zprávy. |

### Vlastnosti instance [#instance-props]

| Prop | Type | Description |
| ---- | ---- | ----------- |
| `meta` | `TMeta` | Pomocné údaje konstruktoru. Lze číst i zapisovat. |
| `message` | `string` | Vyhodnocuje se podle `lang`. Je enumerovatelná. |
| `cause` | `unknown` | Příčina z `ErrorOptions`. Standardní vlastnost `Error`. |

### Konstruktor [#constructor]

Pokud `TMeta` nezahrnuje `undefined`, je `meta` povinné.

```ts
new MyError(meta, message, options?)
```

Pokud je `TMeta` typu `undefined`, lze `meta` vynechat.

```ts
new MyError(message, options?)
new MyError(meta, message, options?)
```

| Parametr | Typ | Popis |
| -------- | --- | ----- |
| `meta` | `TMeta` | Pomocné údaje pro generování zprávy. |
| `message` | `string \| MessageFactory<TMeta>` | Výchozí zpráva pro jazyky bez registrace. Funkce přijímají `meta`. |
| `options` | `ErrorOptions` | Volby kompatibilní s druhým argumentem `Error` (např. `{ cause }`). |

### Pořadí vyhodnocení [#resolution-order]

1. Získá `lang` z `getGlobalConfig()` (`"en"`, není-li nastaveno)
2. Spustí registrovanou funkci pro danou třídu a jazyk s `meta`
3. Není-li registrována, použije výchozí zprávu
4. Je-li `static prefix`, připojí jej na začátek

:::note
Registrace jsou vázány na třídu. Registrace rodiče se nedědí. Registrujte každou třídu.
:::

## `setErrorMessage` [#set-error-message]

Registruje funkce pro tvorbu zprávy pro jednotlivé jazyky.

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

setErrorMessage(MyError, (meta) => `...: ${meta.code}`, "ja");
```

| Parametr | Typ | Popis |
| -------- | --- | ----- |
| `reference` | `I18nErrorBaseConstructor` | Třída dědící z `I18nErrorBase`. Ostatní třídy jsou typovou chybou. |
| `message` | `string \| (meta) => string` | Zpráva k registraci. `meta` se odvodí z cílové třídy. |
| `lang` | `string \| Iterable<string>` | Cílový jazyk. Jednotlivý kód nebo iterovatelný objekt (např. pole). |

Opětovná registrace stejné třídy a jazyka hodnotu přepíše.

## Typy [#types]

### `ErrorMeta` [#error-meta]

```ts
type ErrorMeta = {
  readonly [prop: string]: unknown;
};
```

Výchozí omezení pro `TMeta`. Objekt jen pro čtení s libovolnými vlastnostmi.

### `ErrorOptions` [#error-options]

```ts
type ErrorOptions =
  ConstructorParameters<typeof Error> extends [
    message?: unknown,
    options?: (infer TOptions) | undefined,
  ]
    ? TOptions
    : { readonly cause?: unknown };
```

Typ odvozený z druhého argumentu `Error`. Lze předat `cause`.

### `MessageFactory<TMeta>` [#message-factory]

```ts
interface MessageFactory<TMeta extends ErrorMeta | undefined = ErrorMeta | undefined> {
  (meta: TMeta): string;
}
```

Funkce generující zprávu z `meta`. Používá se pro výchozí i registrované zprávy.

### `I18nErrorBaseParams<TMeta>` [#i18n-error-base-params]

Přetížení argumentů konstruktoru.

```ts
type I18nErrorBaseParams<TMeta extends ErrorMeta | undefined = ErrorMeta | undefined> =
  [TMeta] extends [undefined]
    ?
        | [message: string | MessageFactory<TMeta>, options?: ErrorOptions | undefined]
        | [meta: undefined, message: string | MessageFactory<TMeta>, options?: ErrorOptions | undefined]
    : [meta: TMeta, message: string | MessageFactory<TMeta>, options?: ErrorOptions | undefined];
```

Bez `meta` jen tehdy, je-li `TMeta` typu `undefined`.

### `I18nErrorBaseConstructor` [#i18n-error-base-constructor]

```ts
interface I18nErrorBaseConstructor {
  new (...args: any): I18nErrorBase;
}
```

Typ prvního argumentu `setErrorMessage`.

## Poznámky [#notes]

- Výchozí `lang` je `"en"`. Přepínejte pomocí `setGlobalConfig({ lang })`
- Bez normalizace kódů jazyků a fallback řetězce (např. `en-US` → `en`). Neregistrované jazyky používají výchozí zprávu