Marc Mintel
5397309103
Some checks failed
Build & Deploy / 🔍 Prepare (push) Successful in 20s
Build & Deploy / 🧪 QA (push) Failing after 34s
Build & Deploy / 🏗️ Build (push) Has started running
Build & Deploy / 🚀 Deploy (push) Has been cancelled
Build & Deploy / 🧪 Smoke Test (push) Has been cancelled
Build & Deploy / ⚡ Lighthouse (push) Has been cancelled
Build & Deploy / 🔔 Notify (push) Has been cancelled
55 lines
2.6 KiB
Plaintext
55 lines
2.6 KiB
Plaintext
import type { Locale, Messages } from './AppConfig.js';
|
|
import type Formats from './Formats.js';
|
|
import type IntlError from './IntlError.js';
|
|
import type TimeZone from './TimeZone.js';
|
|
import type { DeepPartial } from './types.js';
|
|
/**
|
|
* Should be used for entry points that configure the library.
|
|
*/
|
|
type IntlConfig = {
|
|
/** A valid Unicode locale tag (e.g. "en" or "en-GB"). */
|
|
locale: Locale;
|
|
/** Global formats can be provided to achieve consistent
|
|
* formatting across components. */
|
|
formats?: Formats | null;
|
|
/** A time zone as defined in [the tz database](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) which will be applied when formatting dates and times. If this is absent, the user time zone will be used. You can override this by supplying an explicit time zone to `formatDateTime`. */
|
|
timeZone?: TimeZone;
|
|
/** This callback will be invoked when an error is encountered during
|
|
* resolving a message or formatting it. This defaults to `console.error` to
|
|
* keep your app running. You can customize the handling by taking
|
|
* `error.code` into account. */
|
|
onError?(error: IntlError): void;
|
|
/** Will be called when a message couldn't be resolved or formatting it led to
|
|
* an error. This defaults to `${namespace}.${key}` You can use this to
|
|
* customize what will be rendered in this case. */
|
|
getMessageFallback?(info: {
|
|
error: IntlError;
|
|
key: string;
|
|
namespace?: string;
|
|
}): string;
|
|
/**
|
|
* Providing this value will have two effects:
|
|
* 1. It will be used as the default for the `now` argument of
|
|
* `useFormatter().formatRelativeTime` if no explicit value is provided.
|
|
* 2. It will be returned as a static value from the `useNow` hook. Note
|
|
* however that when `updateInterval` is configured on the `useNow` hook,
|
|
* the global `now` value will only be used for the initial render, but
|
|
* afterwards the current date will be returned continuously.
|
|
*/
|
|
now?: Date;
|
|
/** All messages that will be available. */
|
|
messages?: DeepPartial<Messages> | null;
|
|
};
|
|
/**
|
|
/**
|
|
* A stricter set of the configuration that should be used internally
|
|
* once defaults are assigned to `IntlConfiguration`.
|
|
*/
|
|
export type InitializedIntlConfig = Omit<IntlConfig, 'formats' | 'messages' | 'onError' | 'getMessageFallback'> & {
|
|
formats?: NonNullable<IntlConfig['formats']>;
|
|
messages?: NonNullable<IntlConfig['messages']>;
|
|
onError: NonNullable<IntlConfig['onError']>;
|
|
getMessageFallback: NonNullable<IntlConfig['getMessageFallback']>;
|
|
};
|
|
export default IntlConfig;
|