@i18n-micro/utils

Framework-agnostic utilities for Nuxt I18n Micro (granular subpath imports).

Entry points: @i18n-micro/utils/accept-language, @i18n-micro/utils/active-locales, @i18n-micro/utils/app-path, @i18n-micro/utils/auto-detect-path, @i18n-micro/utils/cache-control, @i18n-micro/utils/cookie, @i18n-micro/utils/deep-merge, @i18n-micro/utils/domains, @i18n-micro/utils/load-dir, @i18n-micro/utils/locale-head, @i18n-micro/utils/merge-i18n-head, @i18n-micro/utils/merge-source, @i18n-micro/utils/normalize, @i18n-micro/utils/parse-path, @i18n-micro/utils/payload-fetch, @i18n-micro/utils/payload-url, @i18n-micro/utils/resolve-hreflang, @i18n-micro/utils/resolve-locale, @i18n-micro/utils/resolve-og-locale, @i18n-micro/utils/runtime-config, @i18n-micro/utils/source-loader, @i18n-micro/utils/split-locale-routes.

@i18n-micro/utils/accept-language

Functions

detectLocaleFromAcceptLanguage

The config locale an Accept-Language header prefers, in q order; * matches nothing.

function detectLocaleFromAcceptLanguage(
  header: string | undefined,
  validLocales: readonly string[],
): string | null

parseAcceptLanguage

Language tags of an Accept-Language header, most preferred first (stable for equal q). _ becomes -; entries with q=0 or a malformed q are dropped.

function parseAcceptLanguage(header: string | undefined): string[]

@i18n-micro/utils/active-locales

Functions

getEnabledLocaleCodes

function getEnabledLocaleCodes(locales?: Locale[] | null): string[]

See Locale

getEnabledLocales

function getEnabledLocales(locales?: Locale[] | null): Locale[]

See Locale

isEnabledLocale

function isEnabledLocale(locales: Locale[] | null | undefined, code: string): boolean

See Locale

@i18n-micro/utils/app-path

Functions

forwardSlashes

function forwardSlashes(path: string): string

isInternalPath

True for Nuxt/i18n internals, Content __ routes, and static assets that must skip locale detection / redirects. Lives in utils so client middleware can import it without pulling @nuxt/schema (via route-strategy) into the browser bundle. apiBaseUrl is the translations route (_locales by default).

function isInternalPath(
  path: string,
  excludePatterns?: (string | RegExp | object)[],
  apiBaseUrl?: string,
): boolean

isStaticAssetPathname

function isStaticAssetPathname(pathname: string): boolean

resolveContainedRelPath

Normalize a payload-relative path and reject any walk out of the payload root. Callers must use the returned string (or skip the read when this returns null).

function resolveContainedRelPath(relPath: string): string | null

trimLeadingSlashes

function trimLeadingSlashes(path: string): string

trimSlashes

path without the slashes at either end.

function trimSlashes(path: string): string

trimTrailingSlashes

path without the slashes it ends in. A loop: /\/+$/ retries at every slash of a run that stops short of the end, quadratic on a request URL.

function trimTrailingSlashes(path: string): string

withoutAppBaseURL

Strip Nuxt app.baseURL prefix from a request pathname. getRequestURL(event).pathname includes baseURL; Vue Router paths do not.

function withoutAppBaseURL(pathname: string, baseURL?: string | null): string

@i18n-micro/utils/auto-detect-path

Functions

shouldAttemptLocaleRedirect

Whether cookie / Accept-Language preference may steer locale redirects (#242).

Modes (ModuleOptions.autoDetectPath):

• '/' (default) — only /
• 'no_prefix' — any path without a locale prefix
• '*' — every path (also enables aggressive prefixed-URL rewrites in the plugin)
• any other string — that path, trailing slashes ignored

Does not gate strategy / localeRoutes canonicalization: when preference is denied on an unprefixed path, the plugin still runs getClientRedirect with the default locale.

function shouldAttemptLocaleRedirect(
  path: string,
  options?: { autoDetectPath?: string; hasLocalePrefix?: boolean; },
): boolean

@i18n-micro/utils/cache-control

Classes

CacheControl

class CacheControl<T> {
  constructor(options?: CacheControlOptions)
}

See CacheControlOptions

Types

CacheControlOptions

CacheControl — O(1) LRU cache with an optional TTL.

TTL counts from when an entry was stored, not from its last read: a hot entry still expires, so data behind it (a remote apiBaseServerHost) is refreshed at least every ttl seconds.

Map is created internally — no external references, no desync risk.

Performance: get — O(1) (lazy TTL check + LRU reorder via Map delete/set) set — O(1) (LRU eviction via Map.keys().next()) has — O(1) (lazy TTL eviction)

Eviction: LRU (Least Recently Used) based on native Map insertion order.

interface CacheControlOptions

@i18n-micro/utils/cookie

Functions

decodeCookieValue

A cookie value, or null when it is not valid percent-encoding (a malformed cookie is absent).

function decodeCookieValue(value: string): string | null

getHashCookieName

Returns hash cookie name when hashMode is enabled. Returns null when hashMode is false.

function getHashCookieName(config: ModuleOptionsExtend): string | null

See ModuleOptionsExtend

getLocaleCookieName

Returns cookie name from config. If localeCookie === null, returns null (cookies disabled).

function getLocaleCookieName(config: ModuleOptionsExtend): string | null

See ModuleOptionsExtend

getLocaleCookieOptions

Returns options for locale/hash cookies: localeCookieOptions over the defaults. decode keeps a malformed cookie from throwing in Nuxt's useCookie, and hands it back as it came: a value that changed would be written at the end of the request, and that delete would replace the locale a page just stored.

function getLocaleCookieOptions(options?: LocaleCookieOptions): { … }

See LocaleCookieOptions

getPreferenceCookieName

The cookie that holds the visitor's locale preference: the hash cookie under hashMode, else the locale cookie. Server and client read the same one.

function getPreferenceCookieName(config: ModuleOptionsExtend): string | null

See ModuleOptionsExtend

Constants

DEFAULT_COOKIE_MAX_AGE

const DEFAULT_COOKIE_MAX_AGE: number

DEFAULT_COOKIE_NAME

const DEFAULT_COOKIE_NAME: "user-locale"

DEFAULT_HASH_COOKIE_NAME

const DEFAULT_HASH_COOKIE_NAME: "hash-locale"

@i18n-micro/utils/deep-merge

Functions

deepMergeTranslationsRecursive

Deep merge of two translation trees: nested objects merge at any depth, everything else (arrays, scalars, null) replaces.

function deepMergeTranslationsRecursive(
  target: Record<string, unknown>,
  source: Record<string, unknown>,
): Record<string, unknown>

@i18n-micro/utils/domains

Functions

configForHost

config as host sees it: its default, its locales, its origin. Any other host gets config itself and nothing of the request is kept or echoed: the table holds configured hosts only, one per resolved config. A runtime config is never written to, so its table cannot go stale; the build writes one field of its own config late (dateBuild, at modules:done), and no build-time caller of a host config reads it.

function configForHost<T extends ModuleOptionsExtend>(config: T, host: string): T

See ModuleOptionsExtend

withHostDefaults

locales with baseDefault on the default of every host, whether the config named it or not.

function withHostDefaults(locales: Locale[], defaultLocale: string): Locale[]

See Locale

@i18n-micro/utils/load-dir

Functions

additionalTranslationRoots

The folders of additionalTranslationDirs, in merge order: each entry in turn, a relative one in every root (rootDirs order), an absolute one (a module's own folder) once. A folder named twice is read once.

function additionalTranslationRoots(
  rootDirs: string[],
  dirs?: readonly string[],
): string[]

isInsideDir

Whether file lies under dir, on any platform: locales-old is no part of locales.

function isInsideDir(file: string, dir: string): boolean

listTranslationFiles

Every *.json under dir, sorted by relative path so a read does not depend on the file system's order.

function listTranslationFiles(directory: string): TranslationFile[]

See TranslationFile

loadTranslationDir

Reads dir into root and route buckets.

function loadTranslationDir<T extends Dictionary = Dictionary>(
  dir: string,
  disablePageLocales?: boolean,
): TranslationFileBuckets<T>

See TranslationFileBuckets

loadTranslationDirAsync

loadTranslationDir for a running server: file contents are read without blocking it.

function loadTranslationDirAsync<T extends Dictionary = Dictionary>(
  dir: string,
  disablePageLocales?: boolean,
): Promise<TranslationFileBuckets<T>>

See TranslationFileBuckets

loadTranslationFiles

Reads listed files into root and route buckets.

function loadTranslationFiles<T extends Dictionary = Dictionary>(
  files: TranslationFile[],
  disablePageLocales?: boolean,
): TranslationFileBuckets<T>

See TranslationFile · TranslationFileBuckets

parseJsonFile

JSON.parse of a file's text. A BOM from an editor is fine.

function parseJsonFile(text: string): unknown

parseTranslationFile

The dictionary in a file's text, null (reported) when it is not a JSON object.

function parseTranslationFile(text: string, path: string): Dictionary | null

resolveTranslationFile

The real path of an existing regular .json file file, relative to base, or null when it is missing or leaves base: by ../, an absolute path or a symlink (both sides are resolved to real paths).

function resolveTranslationFile(base: string, file: string): string | null

Types

TranslationFile

The one reader of a locales directory. Node only: never import it from a browser or edge entry. Every adapter that reads the disk (node, astro, vitepress, devtools, types) agrees on what a file is: any *.json under the directory, symlinks followed; broken and non-object files are reported and skipped; a missing directory warns and reads as empty.

interface TranslationFile

@i18n-micro/utils/locale-head

Functions

buildLocaleHead

The SEO head of a page: lang/dir, canonical, hreflang, x-default and the og: tags. Pure: every adapter says what its router knows and all of them emit the same tags.

function buildLocaleHead(input: LocaleHeadInput): LocaleHead

See LocaleHeadInput · LocaleHead

filterQuery

Keeps the whitelist query params of a path or URL and drops its hash.

function filterQuery(url: string, whitelist: readonly string[]): string

joinBase

base + path with one slash between them: '/' + /de or //de is /de, never the protocol-relative //de. A browser reads \ as / and drops a tab or a newline, so /\host is that form as well.

function joinBase(base: string, path: string): string

queryString

?a=1&a=2 of a route's query: arrays repeat the key, null is a key with no value, undefined is left out.

function queryString(query?: object | null): string

Types

LocaleHead

interface LocaleHead

LocaleHeadAlternateLink

interface LocaleHeadAlternateLink

LocaleHeadAttrs

interface LocaleHeadAttrs

LocaleHeadCanonicalLink

interface LocaleHeadCanonicalLink

LocaleHeadInput

interface LocaleHeadInput

LocaleHeadLink

One type per rel, as in unhead: its useHead takes no link with a plain rel: string.

type LocaleHeadLink = LocaleHeadCanonicalLink | LocaleHeadAlternateLink

See LocaleHeadCanonicalLink · LocaleHeadAlternateLink

LocaleHeadMeta

interface LocaleHeadMeta

@i18n-micro/utils/merge-i18n-head

Functions

mergeI18nHead

function mergeI18nHead(
  base: I18nHeadObject,
  override: I18nHeadInput | null | undefined,
  options?: MergeI18nHeadOptions,
): I18nHeadObject

See I18nHeadObject · I18nHeadInput · MergeI18nHeadOptions

Types

I18nHeadObject

interface I18nHeadObject

MergeI18nHeadOptions

interface MergeI18nHeadOptions

@i18n-micro/utils/merge-source

Functions

buildFallbackLocaleChain

Locales whose files make up locale, weakest first: the global fallback, then each fallbackLocale link followed to its end (fr → de → en is [en, de, fr]), then the locale.

function buildFallbackLocaleChain(
  locale: string,
  locales: SourceLocaleInfo[],
  globalFallbackLocale?: string,
): string[]

See SourceLocaleInfo

buildSourcePagePath

function buildSourcePagePath(pageName: string, localeCode: string): string

buildSourceRootPath

function buildSourceRootPath(localeCode: string): string

mergeOverRoot

A page's tree from its root and its delta, as a deep merge makes it: objects merge, anything else replaces. Only the nodes on the delta's paths are new, the rest is the root's, and the delta is taken as it is: a parsed file has no other owner, and copying a large one costs what parsing it did. A stored tree is never written to.

function mergeOverRoot(
  root: Record<string, unknown>,
  delta: Record<string, unknown>,
): Record<string, unknown>

mergeSourceTranslations

function mergeSourceTranslations(
  input: MergeSourceTranslationsInput,
): Promise<Record<string, unknown>>

See MergeSourceTranslationsInput

mergeTranslationsFromFallbackChainAsync

function mergeTranslationsFromFallbackChainAsync(
  chain: string[],
  readLocaleFile: (relativePath: string) => Record<string, unknown> | Promise<Record<string, unknown>>,
  relativePathForLocale: (localeCode: string) => string,
): Promise<Record<string, unknown>>

normalizeConfiguredLocales

function normalizeConfiguredLocales(
  locales: Array<string | Locale> | undefined,
): SourceLocaleInfo[]

See Locale · SourceLocaleInfo

resolveSourcePageName

function resolveSourcePageName(pageName: string, disablePageLocales?: boolean): string

toPremergedStorageKey

function toPremergedStorageKey(pageName: string, locale: string): string

toSourceStorageKey

Storage key relative to the Nitro unstorage mount (fs-friendly / paths).

function toSourceStorageKey(relativePath: string): string

Constants

PREMERGED_ROOT_MARK

Own key of a premerged file: the root file's content hash, in the root and in every delta made against it. A file without it is a whole chunk (dev, source, the server route, a host's older files) and stands alone.

const PREMERGED_ROOT_MARK: "__i18n_root"

PREMERGED_ROOT_PAGE

Premerged payload of the root dictionary alone (with fallbacks): what a page without its own pages/<name>/ folder shows, instead of an empty dictionary.

const PREMERGED_ROOT_PAGE: "__root"

Types

MergeSourceTranslationsInput

interface MergeSourceTranslationsInput

SourceLocaleInfo

interface SourceLocaleInfo

@i18n-micro/utils/normalize

Functions

toTranslationRecord

Normalize unknown payloads into a mutable record (source loader).

function toTranslationRecord(data: unknown): Record<string, unknown>

toTranslations

Normalize unknown fetch/storage payloads into a plain translation object. Unstorage already runs destr on JSON files — strings are not expected here.

function toTranslations(data: unknown): Translations

See Translations

@i18n-micro/utils/parse-path

Functions

classifyTranslationRelativePath

Classify a translation path, optionally treating page files as root-level translations.

function classifyTranslationRelativePath(
  relativePath: string,
  disablePageLocales?: boolean,
): ParsedTranslationRelativePath

See ParsedTranslationRelativePath

pagePathSegmentsToRouteName

Convert nested page path segments to a route name (e.g. user/profile → user-profile).

function pagePathSegmentsToRouteName(segments: string[]): string | null

parseTranslationRelativePath

Parse a translation file path relative to the locales root. Examples: en.json, pages/about/en.json, pages/user/profile/en.json A __proto__ page or locale is ignored: as a bucket key it would write the prototype.

function parseTranslationRelativePath(
  relativePath: string,
): ParsedTranslationRelativePath

See ParsedTranslationRelativePath

storeLoadedTranslationFile

Store a loaded translation file in root or route buckets based on its relative path.

function storeLoadedTranslationFile<T extends Record<string, unknown>>(
  buckets: TranslationFileBuckets<T>,
  relativePath: string,
  translations: T,
  disablePageLocales?: boolean,
): void

See TranslationFileBuckets

Types

ParsedTranslationRelativePath

type ParsedTranslationRelativePath = {
  type: 'page';
  pageName: string;
  locale: string;
} | {
  type: 'root';
  locale: string;
} | {
  type: 'ignore';
}

TranslationFileBuckets

interface TranslationFileBuckets<T = Record<string, unknown>>

@i18n-micro/utils/payload-fetch

Functions

fetchTranslationPayloadFromHost

function fetchTranslationPayloadFromHost(
  config: TranslationPayloadHostConfig,
  locale: string,
  page: string,
  fetcher: TranslationPayloadFetcher,
): Promise<Translations | null>

See TranslationPayloadHostConfig · TranslationPayloadFetcher · Translations

Types

TranslationPayloadFetcher

type TranslationPayloadFetcher = <T>(path: string, options: {
  baseURL: string;
  params?: Record<string, string | number>;
  cache?: RequestCache;
  timeout?: number;
}) => Promise<T>

TranslationPayloadHostConfig

interface TranslationPayloadHostConfig

@i18n-micro/utils/payload-url

Functions

buildTranslationPayloadCacheControl

Builds Cache-Control for /{apiBaseUrl}/:page/:locale/data.json.

immutable is only emitted when a cache-buster is active (hasCacheBuster), i.e. requests carry ?v=<dateBuild>. Without a cache-buster (dateBuild set to 0/'') the URL is stable across deploys, so we intentionally avoid long-lived caching by returning a conservative max-age=0 policy.

Returns null when caching should be skipped — non-positive or non-finite duration (guards NaN/Infinity from producing a malformed header).

function buildTranslationPayloadCacheControl(
  durationSeconds: number | undefined,
  hasCacheBuster?: boolean,
): string | null

buildTranslationPayloadFetchRequest

function buildTranslationPayloadFetchRequest(
  input: TranslationPayloadFetchRequestInput,
): { path: string; baseURL: string; params?: Record<string, string | number>; }

See TranslationPayloadFetchRequestInput

buildTranslationPayloadPath

function buildTranslationPayloadPath(
  apiBaseUrl: string,
  page: string,
  locale: string,
): string

resolveTranslationPayloadBaseURL

function resolveTranslationPayloadBaseURL(
  options: {
    isServer: boolean;
    baseURL: string;
    apiBaseClientHost?: string;
    apiBaseServerHost?: string;
  },
): string

resolveTranslationPayloadCachePolicy

The URL with the current v is the version-pinned one, like a hashed asset. private: a CDN that ignores the query must not answer the next v from this response, and pin an old dictionary in a browser for a year. An old v stays servable, as cached HTML still names it, and revalidates. A file header is path-wide, so it stays short.

function resolveTranslationPayloadCachePolicy(
  input: TranslationPayloadCacheInput,
): TranslationPayloadCachePolicy

See TranslationPayloadCacheInput · TranslationPayloadCachePolicy

resolveTranslationPayloadPage

function resolveTranslationPayloadPage(
  routeName: string | undefined,
  routesLocaleLinks?: Record<string, string>,
): string

Constants

TRANSLATION_PAYLOAD_FILE_CACHE_CONTROL

What a path-wide header can promise: it cannot see ?v=, so a host's copy stays short. No stale-while-revalidate: past max-age, which a CDN's Age reaches on a first visit, Chromium revalidates a fetch() or a preload of this file with a loader that never reads the body, so that request is never reported finished and networkidle never comes.

const TRANSLATION_PAYLOAD_FILE_CACHE_CONTROL: "public, max-age=60"

Types

TranslationPayloadCacheInput

interface TranslationPayloadCacheInput

TranslationPayloadCachePolicy

interface TranslationPayloadCachePolicy

TranslationPayloadFetchRequestInput

interface TranslationPayloadFetchRequestInput

@i18n-micro/utils/resolve-hreflang

Functions

resolveHreflangAlternates

Resolve hreflang values for SEO alternate links. Uses iso || code — never emits routing code when iso is set (#243).

function resolveHreflangAlternates(
  locales: HreflangLocaleInput[],
  options?: ResolveHreflangAlternatesOptions,
): HreflangAlternate[]

See HreflangLocaleInput · ResolveHreflangAlternatesOptions · HreflangAlternate

Types

HreflangAlternate

interface HreflangAlternate

HreflangLocaleInput

type HreflangLocaleInput = Pick<Locale, 'code' | 'iso'>

See Locale

ResolveHreflangAlternatesOptions

interface ResolveHreflangAlternatesOptions

@i18n-micro/utils/resolve-locale

Functions

explicitLocale

The first valid explicit source: url → query (query → url with queryFirst) → state → cookie; null when none is valid. An invalid value never hides a valid one after it.

function explicitLocale(input: Omit<ResolveLocaleInput, 'defaultLocale'>): string | null

See ResolveLocaleInput

firstQueryValue

A query value as one locale candidate: ?locale=a&locale=b is a.

function firstQueryValue(value: unknown): string | null

localeFromPath

Locale code in the first path segment, or null.

function localeFromPath(path: string, validLocales: readonly string[]): string | null

preferenceCounts

Whether cookie, state and Accept-Language decide this URL's redirect.

function preferenceCounts(
  input: Pick<RedirectLocaleInput, 'path' | 'urlLocale' | 'autoDetectPath' | 'alwaysPrefixed'>,
): boolean

See RedirectLocaleInput

redirectLocale

The locale a locale redirect aims at: resolveLocale over state → cookie → Accept-Language wherever autoDetectPath lets preference count ('*': every path), and on every unprefixed URL under prefix. Elsewhere an unprefixed URL keeps the default locale, so it still canonicalizes (localeRoutes aliases). The URL is not a source here: it is what the redirect may move.

function redirectLocale(input: RedirectLocaleInput): string

See RedirectLocaleInput

resolveLocale

The one precedence: explicitLocale, then Accept-Language (only with autoDetectLanguage and no explicit source), then the default.

function resolveLocale(input: ResolveLocaleInput): string

See ResolveLocaleInput

Types

RedirectLocaleInput

interface RedirectLocaleInput extends Omit<ResolveLocaleInput, 'url' | 'query' | 'queryFirst'>

See ResolveLocaleInput

ResolveLocaleInput

Every source a caller may have for the locale of a request or navigation. A caller passes only the sources it has (and is allowed to use); the order between them lives here only.

interface ResolveLocaleInput

@i18n-micro/utils/resolve-og-locale

Functions

resolveOgLocale

Resolve Open Graph locale (language_TERRITORY, underscore) for og:locale meta tags. Returns null when the value cannot be determined safely — no tag should be emitted.

function resolveOgLocale(locale: OgLocaleInput): string | null

warnUnresolvedOgLocale

Log a dev-only hint when og:locale / og:locale:alternate cannot be derived.

function warnUnresolvedOgLocale(
  locale: OgLocaleInput,
  options?: WarnUnresolvedOgLocaleOptions,
): void

See WarnUnresolvedOgLocaleOptions

Types

WarnUnresolvedOgLocaleOptions

interface WarnUnresolvedOgLocaleOptions

@i18n-micro/utils/runtime-config

Functions

applyI18nRuntimeOverrides

The build config with runtime overrides applied. Runtime disabledLocales add to the build-time disabled ones (a locale disabled at build has no payloads to re-enable); defaultLocale and fallbackLocale must be enabled. No env reads: see readI18nEnvOverrides. When nothing changes, the build config itself is returned (a disabled build default is still replaced).

function applyI18nRuntimeOverrides<T extends ModuleOptionsExtend>(
  baseConfig: T,
  requested: RuntimeI18nOverrides,
  warn?: (message: string) => void,
): T

See ModuleOptionsExtend · RuntimeI18nOverrides

applyLocaleBaseUrls

config with the runtime locales[].baseUrls, after applyI18nRuntimeOverrides. A build without locale domains has no routing for them (the path strategy is chosen at build): ignored there, like strategy. Apart, so that a browser bundle without domains drops it. metaBaseUrl stays: who moves the default locale's domain sets NUXT_I18N_META_BASE_URL too.

function applyLocaleBaseUrls<T extends ModuleOptionsExtend>(
  config: T,
  overrides: RuntimeI18nOverrides,
  warn?: (message: string) => void,
): T

See ModuleOptionsExtend · RuntimeI18nOverrides

createI18nConfigResolver

applyI18nRuntimeOverrides with runtimeConfig.public.i18nRuntime first, then env vars, memoized for one process: env is read once, and the same config object answers while the base config and the overrides are unchanged (so warnings are logged once). That object is shared by every request: in dev it is deep-frozen, so a mutation throws instead of leaking into later requests.

function createI18nConfigResolver(
  warn?: (message: string) => void,
): <T extends ModuleOptionsExtend>(baseConfig: T, runtimePublic?: Record<string, unknown>) => T

See ModuleOptionsExtend

i18nOverridesKey

A stable string of the overrides: equal strings resolve to equal configs.

function i18nOverridesKey(overrides: RuntimeI18nOverrides): string

See RuntimeI18nOverrides

mergeI18nOverrides

primary's values, secondary's where primary has none.

function mergeI18nOverrides(
  primary: RuntimeI18nOverrides,
  secondary: RuntimeI18nOverrides,
): RuntimeI18nOverrides

See RuntimeI18nOverrides

readI18nEnvOverrides

Overrides from NUXT_I18N_* / NUXT_PUBLIC_I18N_RUNTIME_* env vars (server only: the browser has no env).

function readI18nEnvOverrides(): RuntimeI18nOverrides

See RuntimeI18nOverrides

readI18nRuntimeOverrides

Overrides from runtimeConfig.public.i18nRuntime.

function readI18nRuntimeOverrides(
  runtimePublic?: Record<string, unknown>,
): RuntimeI18nOverrides

See RuntimeI18nOverrides

readLocaleBaseUrls

runtimeConfig.public.i18nRuntime.localeBaseUrls. Apart from readI18nRuntimeOverrides: only a build with locale domains reads it, so a browser bundle without them drops the parser.

function readLocaleBaseUrls(
  runtimePublic?: Record<string, unknown>,
): Record<string, string> | undefined

Types

RuntimeI18nOverrides

interface RuntimeI18nOverrides

@i18n-micro/utils/source-loader

Functions

loadSourceTranslationsFromStorage

function loadSourceTranslationsFromStorage(
  storage: TranslationStorageReader,
  input: Omit<MergeSourceTranslationsInput, 'readLocaleFile'>,
): Promise<Translations>

See TranslationStorageReader · MergeSourceTranslationsInput · Translations

Types

TranslationStorageReader

interface TranslationStorageReader

@i18n-micro/utils/split-locale-routes

Functions

splitLocaleRoutes

Split one programmatic route registry into Nuxt pages + globalLocaleRoutes (#244).

Keeps both halves in sync and keys locale paths by route name (not file path), so N routes sharing one wrapper SFC do not overwrite each other.

function splitLocaleRoutes(
  entries: readonly SplitLocaleRouteEntry[],
): SplitLocaleRoutesResult

See SplitLocaleRouteEntry · SplitLocaleRoutesResult

Types

SplitLocaleRouteEntry

One programmatic route entry for splitLocaleRoutes (#244). Prefer route name as the globalLocaleRoutes key so shared wrapper SFCs do not collapse.

interface SplitLocaleRouteEntry

SplitLocaleRoutePage

interface SplitLocaleRoutePage

SplitLocaleRoutesResult

interface SplitLocaleRoutesResult

Generated from the TypeScript sources and their JSDoc by pnpm run docs:generate. Back to all packages · Integration guides