gt-react 9.2.26 → 9.2.27-alpha.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/client.d.ts CHANGED
@@ -552,7 +552,26 @@ declare function useLocaleSelector(locales?: string[]): {
552
552
  setLocale: (locale: string) => void;
553
553
  };
554
554
 
555
+ /**
556
+ * Returns the configured GT class instance.
557
+ *
558
+ * @returns {GT} The configured GT class instance.
559
+ *
560
+ * @example
561
+ * const gt = useGTClass();
562
+ * console.log(gt.getLocaleProperties('en-US'));
563
+ */
555
564
  declare function useGTClass(): generaltranslation.GT;
565
+ /**
566
+ * Returns the locale properties for the given locale.
567
+ *
568
+ * @param {string} locale - The locale to get the properties for.
569
+ * @returns {LocaleProperties} The locale properties for the given locale.
570
+ *
571
+ * @example
572
+ * const localeProperties = useLocaleProperties('en-US');
573
+ * console.log(localeProperties);
574
+ */
556
575
  declare function useLocaleProperties(locale: string): generaltranslation_types.LocaleProperties;
557
576
 
558
577
  export { Branch, ClientProvider, Currency, DateTime, GTContext, GTProvider, LocaleSelector, Num, Plural, T, Var, renderVariable, useDefaultLocale, useTranslations as useDict, useGT, useGTClass, useLocale, useLocaleProperties, useLocaleSelector, useLocales, useRuntimeTranslation, useSetLocale, useTranslations };
@@ -1,3 +1,22 @@
1
+ /**
2
+ * Returns the configured GT class instance.
3
+ *
4
+ * @returns {GT} The configured GT class instance.
5
+ *
6
+ * @example
7
+ * const gt = useGTClass();
8
+ * console.log(gt.getLocaleProperties('en-US'));
9
+ */
1
10
  export declare function useGTClass(): import("generaltranslation").GT;
11
+ /**
12
+ * Returns the locale properties for the given locale.
13
+ *
14
+ * @param {string} locale - The locale to get the properties for.
15
+ * @returns {LocaleProperties} The locale properties for the given locale.
16
+ *
17
+ * @example
18
+ * const localeProperties = useLocaleProperties('en-US');
19
+ * console.log(localeProperties);
20
+ */
2
21
  export declare function useLocaleProperties(locale: string): import("generaltranslation/types").LocaleProperties;
3
22
  //# sourceMappingURL=useGTClass.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"useGTClass.d.ts","sourceRoot":"","sources":["../../src/hooks/useGTClass.ts"],"names":[],"mappings":"AAEA,wBAAgB,UAAU,oCAIzB;AAED,wBAAgB,mBAAmB,CAAC,MAAM,EAAE,MAAM,uDAGjD"}
1
+ {"version":3,"file":"useGTClass.d.ts","sourceRoot":"","sources":["../../src/hooks/useGTClass.ts"],"names":[],"mappings":"AAEA;;;;;;;;GAQG;AACH,wBAAgB,UAAU,oCAIzB;AAED;;;;;;;;;GASG;AACH,wBAAgB,mBAAmB,CAAC,MAAM,EAAE,MAAM,uDAGjD"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "gt-react",
3
- "version": "9.2.26",
3
+ "version": "9.2.27-alpha.0",
4
4
  "description": "A React library for automatic internationalization.",
5
5
  "main": "./dist/index.cjs.min.cjs",
6
6
  "module": "./dist/index.esm.min.mjs",