react-intl/server.d.ts

Internationalize React apps. This library provides React components and an API to format dates, numbers, and strings, including pluralization and handling translations.

import { CreateIntlFn, FormatDurationOptions, FormattedText, Formatters, IntlCache, IntlFormatters, MessageArgumentsFromCatalog, MessageDescriptor, MessageDescriptor as MessageDescriptor$1, MessageTag, MessageTextOutput, MessageTextOutput as MessageTextOutput$1, MessageValue, MessageValues, MessageValuesOf, MessageValuesOf as MessageValuesOf$1, NoMessageValues, RegisteredMessageId, RegisteredMessageValues, ResolvedIntlConfig as ResolvedIntlConfig$1, TextMessageFormatter, TypedMessageArguments, TypedMessageDescriptor, TypedMessageDescriptor as TypedMessageDescriptor$1, UnregisteredMessageDescriptor, UntypedMessageDescriptor, createIntlCache, defineMessages } from "@formatjs/intl";
import { FormatXMLElementFn, Options, PrimitiveType } from "intl-messageformat";
import * as React from "react";
//#region packages/react-intl/utils.d.ts
type DefaultIntlConfig = Pick<ResolvedIntlConfig, "fallbackOnEmptyString" | "formats" | "messages" | "timeZone" | "textComponent" | "defaultLocale" | "defaultFormats" | "onError">;
declare const DEFAULT_INTL_CONFIG$1: DefaultIntlConfig;
//#endregion
//#region packages/react-intl/types.d.ts
type IntlConfig = Omit<ResolvedIntlConfig, keyof typeof DEFAULT_INTL_CONFIG$1> & Partial<typeof DEFAULT_INTL_CONFIG$1>;
interface ResolvedIntlConfig extends ResolvedIntlConfig$1<React.ReactNode> {
  textComponent?: React.ComponentType | keyof React.JSX.IntrinsicElements;
  wrapRichTextChunksInFragment?: boolean;
}
interface IntlShape extends ResolvedIntlConfig, IntlFormatters<React.ReactNode> {
  formatMessage<V extends MessageValues = never, T extends React.ReactNode = React.ReactNode>(this: void, descriptor: [V] extends [never] ? never : UntypedMessageDescriptor, ...args: TypedMessageArguments<NoInfer<V>, string, T>): MessageTextOutput$1;
  formatMessage<V extends MessageValues = never, T extends React.ReactNode = React.ReactNode>(this: void, descriptor: [V] extends [never] ? never : UntypedMessageDescriptor, ...args: TypedMessageArguments<NoInfer<V>, T>): string | T | Array<string | T>;
  formatMessage<D extends TypedMessageDescriptor$1<MessageValues>>(this: void, descriptor: D, ...args: TypedMessageArguments<MessageValuesOf$1<NoInfer<D>>, string, React.ReactNode>): MessageTextOutput$1;
  formatMessage<D extends TypedMessageDescriptor$1<MessageValues>>(this: void, descriptor: D, ...args: TypedMessageArguments<MessageValuesOf$1<NoInfer<D>>, React.ReactNode>): React.ReactNode;
  formatMessage<const K extends RegisteredMessageId>(this: void, descriptor: UntypedMessageDescriptor & {
    id: K;
  }, ...args: TypedMessageArguments<RegisteredMessageValues<NoInfer<K>>, string, React.ReactNode>): MessageTextOutput$1;
  formatMessage<const K extends RegisteredMessageId>(this: void, descriptor: UntypedMessageDescriptor & {
    id: K;
  }, ...args: TypedMessageArguments<RegisteredMessageValues<NoInfer<K>>, React.ReactNode>): string | React.ReactNode | Array<string | React.ReactNode>;
  formatMessage<V = never, const D extends UntypedMessageDescriptor = UntypedMessageDescriptor>(this: void, descriptor: [V] extends [never] ? D & UnregisteredMessageDescriptor<NoInfer<D>> : never, values?: Record<string, PrimitiveType | FormatXMLElementFn<string, string>>, opts?: Options): MessageTextOutput$1;
  formatMessage<V = never, const D extends UntypedMessageDescriptor = UntypedMessageDescriptor>(this: void, descriptor: [V] extends [never] ? D & UnregisteredMessageDescriptor<NoInfer<D>> : never, values?: Record<string, React.ReactNode | PrimitiveType | FormatXMLElementFn<string, React.ReactNode>>, opts?: Options): Array<React.ReactNode>;
  $t: IntlShape["formatMessage"];
  formatters: Formatters;
}
//#endregion
//#region packages/react-intl/components/createIntl.d.ts
/**
 * Create intl object
 * @param config intl config
 * @param cache cache for formatter instances to prevent memory leak
 */
export declare const createIntl: CreateIntlFn<React.ReactNode, IntlConfig, IntlShape>;
//#endregion
//#region packages/react-intl/define-message.d.ts
export declare function defineMessage<V extends MessageValues = {}, const D extends MessageDescriptor$1 = never>(message: D, options?: {
  typed: true;
}): Readonly<D> & Omit<TypedMessageDescriptor$1<NoInfer<V>>, keyof D>;
export declare function defineMessage<V extends MessageValues = {}>(message: MessageDescriptor$1 & {
  id: NonNullable<MessageDescriptor$1["id"]>;
  defaultMessage: string;
}, options?: {
  typed: true;
}): TypedMessageDescriptor$1<NoInfer<V>> & Readonly<{
  id: NonNullable<MessageDescriptor$1["id"]>;
  defaultMessage: string;
}>;
export declare function defineMessage<V extends MessageValues = {}>(message: MessageDescriptor$1 & {
  id: NonNullable<MessageDescriptor$1["id"]>;
  defaultMessage: NonNullable<MessageDescriptor$1["defaultMessage"]>;
}, options?: {
  typed: true;
}): TypedMessageDescriptor$1<NoInfer<V>> & Readonly<{
  id: NonNullable<MessageDescriptor$1["id"]>;
  defaultMessage: NonNullable<MessageDescriptor$1["defaultMessage"]>;
}>;
export declare function defineMessage<V extends MessageValues = {}>(message: MessageDescriptor$1 & {
  defaultMessage: string;
}, options?: {
  typed: true;
}): TypedMessageDescriptor$1<NoInfer<V>> & Readonly<{
  defaultMessage: string;
}>;
export declare function defineMessage<V extends MessageValues = {}>(message: MessageDescriptor$1 & {
  defaultMessage: NonNullable<MessageDescriptor$1["defaultMessage"]>;
}, options?: {
  typed: true;
}): TypedMessageDescriptor$1<NoInfer<V>> & Readonly<{
  defaultMessage: NonNullable<MessageDescriptor$1["defaultMessage"]>;
}>;
export declare function defineMessage<V extends MessageValues = {}>(message: MessageDescriptor$1 & {
  id: NonNullable<MessageDescriptor$1["id"]>;
}, options?: {
  typed: true;
}): TypedMessageDescriptor$1<NoInfer<V>> & Readonly<{
  id: NonNullable<MessageDescriptor$1["id"]>;
}>;
export declare function defineMessage<V extends MessageValues = {}>(message: MessageDescriptor$1, options?: {
  typed: true;
}): TypedMessageDescriptor$1<NoInfer<V>>;
export declare function defineMessage<T extends MessageDescriptor$1>(message: T): Readonly<T>;
//#endregion
export { type FormatDurationOptions, type FormattedText, type IntlCache, type IntlConfig, type IntlShape, type MessageArgumentsFromCatalog, type MessageDescriptor, type MessageTag, type MessageTextOutput, type MessageValue, type MessageValuesOf, type NoMessageValues, type ResolvedIntlConfig, type TextMessageFormatter, type TypedMessageDescriptor, createIntlCache, defineMessages };
//# sourceMappingURL=server.d.ts.map