Extends
PluginOptions<T>
Type Parameters
T
T = object
Properties
appendNamespaceToCIMode?
Defined in: node_modules/.pnpm/i18next@25.10.10_typescript@7.0.2/node_modules/i18next/typescript/options.d.ts:665 Prefixes the namespace to the returned key when usingoptionalappendNamespaceToCIMode?:boolean
cimode
Default
appendNamespaceToMissingKey?
Defined in: node_modules/.pnpm/i18next@25.10.10_typescript@7.0.2/node_modules/i18next/typescript/options.d.ts:545 Appends namespace to missing keyoptionalappendNamespaceToMissingKey?:boolean
Default
backend?
Defined in: packages/i18next-backend/dist/esm/index.d.ts:26optionalbackend?:Options<T>
Inherited from
PluginOptions.backend
cache?
Defined in: node_modules/.pnpm/i18next@25.10.10_typescript@7.0.2/node_modules/i18next/typescript/options.d.ts:167 Options for cache layer - check documentation of pluginoptionalcache?:object
Default
Inherited from
PluginOptions.cache
cacheInBuiltFormats?
Defined in: node_modules/.pnpm/i18next@25.10.10_typescript@7.0.2/node_modules/i18next/typescript/options.d.ts:752 Initializes the internal formatter for the in-built formats as cached version. Can be set to false for this type of issues: https://github.com/i18next/i18next/issues/2227optionalcacheInBuiltFormats?:boolean
Default
cleanCode?
Defined in: node_modules/.pnpm/i18next@25.10.10_typescript@7.0.2/node_modules/i18next/typescript/options.d.ts:467 Language will be lowercased EN —> en while leaving full locales like en-USoptionalcleanCode?:boolean
Default
compatibilityJSON?
Defined in: node_modules/.pnpm/i18next@25.10.10_typescript@7.0.2/node_modules/i18next/typescript/options.d.ts:672 Compatibility JSON versionoptionalcompatibilityJSON?:"v4"
Warning
onlyv4 is available and supported by typescript
Default
contextSeparator?
Defined in: node_modules/.pnpm/i18next@25.10.10_typescript@7.0.2/node_modules/i18next/typescript/options.d.ts:659 Char to split context from keyoptionalcontextSeparator?:string
Default
debug?
Defined in: node_modules/.pnpm/i18next@25.10.10_typescript@7.0.2/node_modules/i18next/typescript/options.d.ts:398 Logs info level to console output. Helps finding issues with loading not working.optionaldebug?:boolean
Default
defaultNS?
Defined in: node_modules/.pnpm/i18next@25.10.10_typescript@7.0.2/node_modules/i18next/typescript/options.d.ts:479 Default namespace used if not passed to translation functionoptionaldefaultNS?:string|false| readonlystring[]
Default
detection?
Defined in: node_modules/.pnpm/i18next@25.10.10_typescript@7.0.2/node_modules/i18next/typescript/options.d.ts:155 Options for language detection - check documentation of pluginoptionaldetection?:object
Default
Inherited from
PluginOptions.detection
fallbackLng?
Defined in: node_modules/.pnpm/i18next@25.10.10_typescript@7.0.2/node_modules/i18next/typescript/options.d.ts:428 Language to use if translations in user language are not available.optionalfallbackLng?:false|FallbackLng
Default
fallbackNS?
Defined in: node_modules/.pnpm/i18next@25.10.10_typescript@7.0.2/node_modules/i18next/typescript/options.d.ts:485 String or array of namespaces to lookup key if not found in given namespace.optionalfallbackNS?:string|false| readonlystring[]
Default
i18nFormat?
Defined in: node_modules/.pnpm/i18next@25.10.10_typescript@7.0.2/node_modules/i18next/typescript/options.d.ts:173 Options for i18n message format - check documentation of pluginoptionali18nFormat?:object
Default
Inherited from
PluginOptions.i18nFormat
ignoreJSONStructure?
Defined in: node_modules/.pnpm/i18next@25.10.10_typescript@7.0.2/node_modules/i18next/typescript/options.d.ts:719 Automatically lookup for a flat key if a nested key is not found an vice-versaoptionalignoreJSONStructure?:boolean
Default
initAsync?
Defined in: node_modules/.pnpm/i18next@25.10.10_typescript@7.0.2/node_modules/i18next/typescript/options.d.ts:630 Triggers resource loading in init function inside a setTimeout (default async behaviour). Set it to false if your backend loads resources sync - that way calling i18next.t after init is possible without relaying on the init callback.optionalinitAsync?:boolean
Default
initImmediate?
Defined in: node_modules/.pnpm/i18next@25.10.10_typescript@7.0.2/node_modules/i18next/typescript/options.d.ts:635optionalinitImmediate?:boolean
Deprecated
Use initAsync instead.interpolation?
Defined in: node_modules/.pnpm/i18next@25.10.10_typescript@7.0.2/node_modules/i18next/typescript/options.d.ts:616optionalinterpolation?:InterpolationOptions
See
https://www.i18next.com/translation-function/interpolationjoinArrays?
Defined in: node_modules/.pnpm/i18next@25.10.10_typescript@7.0.2/node_modules/i18next/typescript/options.d.ts:605 Char, eg. ‘\n’ that arrays will be joined byoptionaljoinArrays?:string|false
Default
keySeparator?
Defined in: node_modules/.pnpm/i18next@25.10.10_typescript@7.0.2/node_modules/i18next/typescript/options.d.ts:641 Char to separate keysoptionalkeySeparator?:string|false
Default
lng?
Defined in: node_modules/.pnpm/i18next@25.10.10_typescript@7.0.2/node_modules/i18next/typescript/options.d.ts:422 Language to use (overrides language detection)optionallng?:string
Default
load?
Defined in: node_modules/.pnpm/i18next@25.10.10_typescript@7.0.2/node_modules/i18next/typescript/options.d.ts:449 Language codes to lookup, given set language is ‘en-US’: ‘all’ —> [‘en-US’, ‘en’, ‘dev’], ‘currentOnly’ —> ‘en-US’, ‘languageOnly’ —> ‘en’optionalload?:"all"|"currentOnly"|"languageOnly"
Default
locizeLastUsed?
Defined in: node_modules/.pnpm/i18next@25.10.10_typescript@7.0.2/node_modules/i18next/typescript/options.d.ts:678 Options for https://github.com/locize/locize-lastusedoptionallocizeLastUsed?:object
allowedHosts?
Hostnames that are allowed to send last used data. Please keep those to your local system, staging, test servers (not production)optionalallowedHosts?: readonlystring[]
Default
apiKey?
An api key if you want to send missing keysoptionalapiKey?:string
debounceSubmit?
Debounce interval to send data in millisecondsoptionaldebounceSubmit?:number
Default
projectId
projectId: string
The id of your locize project
referenceLng?
The reference language of your projectoptionalreferenceLng?:string
Default
version?
Versionoptionalversion?:string
Default
Default
lowerCaseLng?
Defined in: node_modules/.pnpm/i18next@25.10.10_typescript@7.0.2/node_modules/i18next/typescript/options.d.ts:461 Language will be lowercased eg. en-US —> en-usoptionallowerCaseLng?:boolean
Default
maxParallelReads?
Defined in: node_modules/.pnpm/i18next@25.10.10_typescript@7.0.2/node_modules/i18next/typescript/options.d.ts:728 Limit parallelism of calls to backend This is needed to prevent trying to open thousands of sockets or file descriptors, which can cause failures and actually make the entire process take longer.optionalmaxParallelReads?:number
Default
maxRetries?
Defined in: node_modules/.pnpm/i18next@25.10.10_typescript@7.0.2/node_modules/i18next/typescript/options.d.ts:737 The maximum number of retries to perform. Note that retries are only performed when a request has no response and throws an error. The default value is used if value is set below 0.optionalmaxRetries?:number
Default
missingInterpolationHandler?
Defined in: node_modules/.pnpm/i18next@25.10.10_typescript@7.0.2/node_modules/i18next/typescript/options.d.ts:551 Gets called in case a interpolation value is undefined. This method will not be called if the value is empty string or nulloptionalmissingInterpolationHandler?: (text,value,options) =>any
Parameters
text
string
value
any
options
InitOptions
Returns
any
Default
missingKeyHandler?
Defined in: node_modules/.pnpm/i18next@25.10.10_typescript@7.0.2/node_modules/i18next/typescript/options.d.ts:524 Used for custom missing key handling (needs saveMissing set to true!)optionalmissingKeyHandler?:false| ((lngs,ns,key,fallbackValue,updateMissing,options) =>void)
Default
missingKeyNoValueFallbackToKey?
Defined in: node_modules/.pnpm/i18next@25.10.10_typescript@7.0.2/node_modules/i18next/typescript/options.d.ts:518 Used to not fallback to the key as default value, when using saveMissing functionality. i.e. when using with i18next-http-backend this will result in having a key with an empty string value.optionalmissingKeyNoValueFallbackToKey?:boolean
Default
nonExplicitSupportedLngs?
Defined in: node_modules/.pnpm/i18next@25.10.10_typescript@7.0.2/node_modules/i18next/typescript/options.d.ts:440 If true will pass eg. en-US if finding en in supportedLngsoptionalnonExplicitSupportedLngs?:boolean
Default
ns?
Defined in: node_modules/.pnpm/i18next@25.10.10_typescript@7.0.2/node_modules/i18next/typescript/options.d.ts:473 String or array of namespaces to loadoptionalns?:string| readonlystring[]
Default
nsSeparator?
Defined in: node_modules/.pnpm/i18next@25.10.10_typescript@7.0.2/node_modules/i18next/typescript/options.d.ts:647 Char to split namespace from keyoptionalnsSeparator?:string|false
Default
partialBundledLanguages?
Defined in: node_modules/.pnpm/i18next@25.10.10_typescript@7.0.2/node_modules/i18next/typescript/options.d.ts:416 Allow initializing with bundled resources while using a backend to load non bundled ones.optionalpartialBundledLanguages?:boolean
Default
pluralSeparator?
Defined in: node_modules/.pnpm/i18next@25.10.10_typescript@7.0.2/node_modules/i18next/typescript/options.d.ts:653 Char to split plural from keyoptionalpluralSeparator?:string
Default
postProcess?
Defined in: node_modules/.pnpm/i18next@25.10.10_typescript@7.0.2/node_modules/i18next/typescript/options.d.ts:563 String or array of postProcessors to apply per defaultoptionalpostProcess?:string|false| readonlystring[]
Default
postProcessPassResolved?
Defined in: node_modules/.pnpm/i18next@25.10.10_typescript@7.0.2/node_modules/i18next/typescript/options.d.ts:569 passthrough the resolved object including ‘usedNS’, ‘usedLang’ etc into options object of postprocessors as ‘i18nResolved’ propertyoptionalpostProcessPassResolved?:boolean
Default
preload?
Defined in: node_modules/.pnpm/i18next@25.10.10_typescript@7.0.2/node_modules/i18next/typescript/options.d.ts:455 Array of languages to preload. Important on server-side to assert translations are loaded before rendering views.optionalpreload?:false| readonlystring[]
Default
react?
Defined in: node_modules/.pnpm/i18next@25.10.10_typescript@7.0.2/node_modules/i18next/typescript/options.d.ts:622 Options for react - check documentation of pluginoptionalreact?:ReactOptions
Default
resources?
Defined in: node_modules/.pnpm/i18next@25.10.10_typescript@7.0.2/node_modules/i18next/typescript/options.d.ts:410 Resources to initialize with (if not using loading or not appending using addResourceBundle)optionalresources?:Resource
Default
retryTimeout?
Defined in: node_modules/.pnpm/i18next@25.10.10_typescript@7.0.2/node_modules/i18next/typescript/options.d.ts:745 Set how long to wait, in milliseconds, between retries of failed requests. This number is compounded by a factor of 2 for subsequent retry. The default value is used if value is set below 1ms.optionalretryTimeout?:number
Default
returnDetails?
Defined in: node_modules/.pnpm/i18next@25.10.10_typescript@7.0.2/node_modules/i18next/typescript/options.d.ts:593 Returns an object that includes information about the used language, namespace, key and valueoptionalreturnDetails?:boolean
Default
returnEmptyString?
Defined in: node_modules/.pnpm/i18next@25.10.10_typescript@7.0.2/node_modules/i18next/typescript/options.d.ts:581 Allows empty string as valid translationoptionalreturnEmptyString?:boolean
Default
returnNull?
Defined in: node_modules/.pnpm/i18next@25.10.10_typescript@7.0.2/node_modules/i18next/typescript/options.d.ts:575 Allows null values as valid translationoptionalreturnNull?:boolean
Default
returnObjects?
Defined in: node_modules/.pnpm/i18next@25.10.10_typescript@7.0.2/node_modules/i18next/typescript/options.d.ts:587 Allows objects as valid translation resultoptionalreturnObjects?:boolean
Default
saveMissing?
Defined in: node_modules/.pnpm/i18next@25.10.10_typescript@7.0.2/node_modules/i18next/typescript/options.d.ts:491 Calls save missing key function on backend if key not found.optionalsaveMissing?:boolean
Default
saveMissingPlurals?
Defined in: node_modules/.pnpm/i18next@25.10.10_typescript@7.0.2/node_modules/i18next/typescript/options.d.ts:497 Calls save missing key function on backend if key not found also for plural forms.optionalsaveMissingPlurals?:boolean
Default
saveMissingTo?
Defined in: node_modules/.pnpm/i18next@25.10.10_typescript@7.0.2/node_modules/i18next/typescript/options.d.ts:511optionalsaveMissingTo?:"all"|"current"|"fallback"
Default
showSupportNotice?
Defined in: node_modules/.pnpm/i18next@25.10.10_typescript@7.0.2/node_modules/i18next/typescript/options.d.ts:404 Show support notice in console during initialization.optionalshowSupportNotice?:boolean
Default
simplifyPluralSuffix?
Defined in: node_modules/.pnpm/i18next@25.10.10_typescript@7.0.2/node_modules/i18next/typescript/options.d.ts:557 Will use ‘plural’ as suffix for languages only having 1 plural form, setting it to false will suffix all with numbersoptionalsimplifyPluralSuffix?:boolean
Default
supportedLngs?
Defined in: node_modules/.pnpm/i18next@25.10.10_typescript@7.0.2/node_modules/i18next/typescript/options.d.ts:434 Array of allowed languagesoptionalsupportedLngs?:false| readonlystring[]
Default
updateMissing?
Defined in: node_modules/.pnpm/i18next@25.10.10_typescript@7.0.2/node_modules/i18next/typescript/options.d.ts:506 Experimental: enable to update default values using the saveMissing (Works only if defaultValue different from translated value. Only useful on initial development or when keeping code as source of truth not changing values outside of code. Only supported if backend supports it already)optionalupdateMissing?:boolean
Default
Methods
overloadTranslationOptionHandler()?
Defined in: node_modules/.pnpm/i18next@25.10.10_typescript@7.0.2/node_modules/i18next/typescript/options.d.ts:611 Sets defaultValueoptionaloverloadTranslationOptionHandler(args):TOptions
Parameters
args
string[]
Returns
TOptions
Default
parseMissingKeyHandler()?
Defined in: node_modules/.pnpm/i18next@25.10.10_typescript@7.0.2/node_modules/i18next/typescript/options.d.ts:539 Receives a key that was not found inoptionalparseMissingKeyHandler(key,defaultValue?,options?):any
t() and returns a value, that will be returned by t()
Parameters
key
string
defaultValue?
string
options?
any
Returns
any
Default
returnedObjectHandler()?
Defined in: node_modules/.pnpm/i18next@25.10.10_typescript@7.0.2/node_modules/i18next/typescript/options.d.ts:599 Gets called if object was passed in as key but returnObjects was set to falseoptionalreturnedObjectHandler(key,value,options):void
Parameters
key
string
value
string
options
any
Returns
void