⭐ new(index): add availableLocales (related issue #193, PR #528) by @…

…exoego * feat(index): Fix #193 add availableLocales * Update src/index.js Co-Authored-By: exoego <[email protected]> * feat(index): Fix #193 add type definition to availableLocales * fix(index): add missing type definition to numberFormats * fix(index): Fix #193 add docs to availableLocales * Update vuepress/api/README.md Co-Authored-By: exoego <[email protected]> * fix(index): Fix #193 ensure order of locales
kazupon · Mar 8, 2019 · 8f75b1f · 8f75b1f
1 parent 396c5ca
commit 8f75b1f
Show file tree

Hide file tree

Showing 5 changed files with 21 additions and 0 deletions.
diff --git a/decls/i18n.js b/decls/i18n.js
@@ -85,6 +85,7 @@ declare interface I18n {
   set fallbackLocale (locale: Locale): void,
   get messages (): LocaleMessages,
   get dateTimeFormats (): DateTimeFormats,
+  get availableLocales (): Locale[],
   get missing (): ?MissingHandler,
   set missing (handler: MissingHandler): void,
   get formatter (): Formatter,

diff --git a/src/index.js b/src/index.js
@@ -169,6 +169,7 @@ export default class VueI18n {
   get messages (): LocaleMessages { return looseClone(this._getMessages()) }
   get dateTimeFormats (): DateTimeFormats { return looseClone(this._getDateTimeFormats()) }
   get numberFormats (): NumberFormats { return looseClone(this._getNumberFormats()) }
+  get availableLocales (): Locale[] { return Object.keys(this.messages).sort() }
 
   get locale (): Locale { return this._vm.locale }
   set locale (locale: Locale): void {

diff --git a/test/unit/basic.test.js b/test/unit/basic.test.js
@@ -629,6 +629,12 @@ describe('basic', () => {
     })
   })
 
+  describe('i18n#availableLocales', () => {
+    it('should return locales defined in messages in lexical order', () => {
+      assert.deepStrictEqual(i18n.availableLocales, ['en', 'ja'])
+    })
+  })
+
   let desc = VueI18n.availabilities.dateTimeFormat ? describe : describe.skip
   desc('i18n#d', () => {
     let dt

diff --git a/types/index.d.ts b/types/index.d.ts
@@ -141,6 +141,7 @@ declare class VueI18n {
   readonly messages: VueI18n.LocaleMessages;
   readonly dateTimeFormats: VueI18n.DateTimeFormats;
   readonly numberFormats: VueI18n.NumberFormats;
+  readonly availableLocales: VueI18n.Locale[];
 
   locale: VueI18n.Locale;
   fallbackLocale: VueI18n.Locale;

diff --git a/vuepress/api/README.md b/vuepress/api/README.md
@@ -209,6 +209,18 @@ The number formats of localization.
 
   * **See also:** `NumberFormats` type of [flowtype definitions](https://github.com/kazupon/vue-i18n/blob/dev/decls/i18n.js)
 
+#### availableLocales
+
+> :new: 8.9.0+
+
+  * **Type:** `Locale[]`
+
+  * **Default:** `[]`
+
+  * **Examples:** `["en", "ja"]`
+
+The list of available locales in `messages` in lexical order.
+
 #### formatter
 
   * **Type:** `Formatter`