Class RemixI18Next

Index

Constructors

Methods

getFixedT getLocale getRouteNamespaces

Constructors

constructor

new RemixI18Next(options: RemixI18NextOption): RemixI18Next
Parameters
- options: RemixI18NextOption
Returns RemixI18Next
- Defined in server.ts:47

Methods

getFixedT

getFixedT<
    N extends string
    | readonly [string, string] = "translation",
    KPrefix extends KeyPrefix<Ns> = undefined,
>(
    locale: string,
    namespaces?: N,
    options?: Omit<InitOptions<object>, "react"> & { keyPrefix?: KPrefix },
): Promise<TFunction<FallbackNs<N>, KPrefix>>
Return a TFunction that can be used to translate strings server-side. This function is fixed to a specific namespace.
Type Parameters
- N extends string | readonly [string, string] = "translation"
- KPrefix extends KeyPrefix<Ns> = undefined
Parameters
- locale: string
- Optionalnamespaces: N
  The namespaces to use for the T function. (Default: translation).
- Optionaloptions: Omit<InitOptions<object>, "react"> & { keyPrefix?: KPrefix }
  The i18next init options and the key prefix to prepend to translation keys.
Returns Promise<TFunction<FallbackNs<N>, KPrefix>>
- Defined in server.ts:103
getFixedT<
    N extends string
    | readonly [string, string] = "translation",
    KPrefix extends KeyPrefix<Ns> = undefined,
>(
    request: Request,
    namespaces?: N,
    options?: Omit<InitOptions<object>, "react"> & { keyPrefix?: KPrefix },
): Promise<TFunction<FallbackNs<N>, KPrefix>>
Return a TFunction that can be used to translate strings server-side. This function is fixed to a specific namespace.
Type Parameters
- N extends string | readonly [string, string] = "translation"
- KPrefix extends KeyPrefix<Ns> = undefined
Parameters
- request: Request
- Optionalnamespaces: N
  The namespaces to use for the T function. (Default: translation).
- Optionaloptions: Omit<InitOptions<object>, "react"> & { keyPrefix?: KPrefix }
  The i18next init options and the key prefix to prepend to translation keys.
Returns Promise<TFunction<FallbackNs<N>, KPrefix>>
- Defined in server.ts:113

getLocale

getLocale(request: Request): Promise<string>
Detect the current locale by following the order defined in the detection.order option. By default the order is
- searchParams
- cookie
- session
- header And finally the fallback language.
Parameters
- request: Request
Returns Promise<string>
- Defined in server.ts:61

getRouteNamespaces

getRouteNamespaces(context: EntryContext): string[]
Get the namespaces required by the routes which are going to be rendered when doing SSR.
Parameters
- context: EntryContext
  The EntryContext object received by handleRequest in entry.server
Returns string[]
Example
```
await instance.init({
  ns: i18n.getRouteNamespaces(context),
  // ...more options
});
```
- Defined in server.ts:77