gt-node 0.6.1 → 0.6.3

package/dist/index.d.ts

@@ -24,4 +24,31 @@ declare function initializeGT(params: InitializeGTParams): void;
  */
 declare function withGT<T>(locale: string, fn: () => T): T;
 
-export { initializeGT, withGT };
+/**
+ * A request object like interface
+ * @interface RequestLike
+ * @property {Record<string, string | string[] | undefined>} headers - The request headers
+ */
+interface RequestLike {
+    headers: Record<string, string | string[] | undefined>;
+}
+/**
+ * Resolve the preferred locale from the request Accept-Language header, fallback to the default locale if no match is found
+ * @param request - The request object
+ * @returns The preferred locale
+ *
+ * @example
+ * const locale = getRequestLocale({ headers: { 'accept-language': 'fr-FR,fr;q=0.9,en;q=0.8' } });
+ * console.log(locale); // 'fr'
+ *
+ * @example
+ * app.get('/', (req, res) => {
+ *   const locale = getRequestLocale(req);
+ *   withGT(locale, () => {
+ *     res.send(`Locale: ${locale}`);
+ *   });
+ * });
+ */
+declare function getRequestLocale(request: RequestLike): string;
+
+export { getRequestLocale, initializeGT, withGT };