Get current locale

[MickL]

Clear and concise description of the problem

I am missing documentation on how to get the locale of the current event. What I would expect:

export default defineEventHandler(async (event) => {
   console.log(event.context.locale);
});

From what I am guess, one needs to call a function at the moment. This however, will each time call the localeDetector:

event.context.i18n.locale()

Additionally this shows up a TypeScript error Type String has no call signatures. even tho it is a function and not a string.

[MickL]

As a workaround, I solved it by running my localeDetector before i18nMiddleware and save the locale into event.context:

export default defineNitroPlugin((nitroApp) => {
  const { onRequest, onAfterResponse } = defineI18nMiddleware({
    locale: event => event.context.locale,
    // ...
  });

  nitroApp.hooks.hook('request', event => {
    event.context.locale = getQueryLocale(event, { lang: defaultLocale }).toString();
    return onRequest(event);
  });
  nitroApp.hooks.hook('afterResponse', onAfterResponse);
});

declare module 'h3' {
  interface H3EventContext {
    locale: string;
  }
}

This does:

1. Current locale always accessible in every request at event.context.locale
2. localeDetector doesnt run twice when accessing locale

[kazupon]

The middleware provided by intlify/h3 is primarily intended for use with useTranslation.
If you only need to detect the locale and not localize text, you can use the utilities API provided by intlify/h3 for detection.

https://github.com/intlify/srvmid/blob/main/packages/h3/docs/index.md

[MickL]

But why not save current locale into event.context.locale like I did in my workaround example? Would be very very useful! :)