feat: add te for composition API (#200)

intlify · Nov 30, 2020 · e59f756 · e59f756
1 parent fab6b75
commit e59f756
Show file tree

Hide file tree

Showing 4 changed files with 44 additions and 9 deletions.
diff --git a/docs/advanced/composition.md b/docs/advanced/composition.md
@@ -491,7 +491,7 @@ Below is the mapping table:
 | `preserveDirectiveContent` | N/A |
 | `t` | `t` |
 | `tc` | `t` |
-| `te` | N/A |
+| `te` | `te` |
 | `tm` | `tm` |
 | `getLocaleMessage` | `getLocaleMessage` |
 | `setLocaleMessage` | `setLocaleMessage`|

diff --git a/src/composer.ts b/src/composer.ts
@@ -748,6 +748,20 @@ export interface Composer<
   n(value: number, options: NumberOptions): string
   /** @internal */
   n(...args: unknown[]): string
+  /**
+   * Translation locale message exist
+   *
+   * @remarks
+   * whether do exist locale message on Composer instance [messages](composition#messages).
+   *
+   * If you specified `locale`, check the locale messages of `locale`.
+   *
+   * @param key - A target locale message key
+   * @param locale - A locale, it will be used over than global scope or local scope
+   *
+   * @returns If found locale message, `true`, else `false`
+   */
+  te(key: Path, locale?: Locale): boolean
   /**
    * Locale messages getter
    *
@@ -1413,6 +1427,13 @@ export function createComposer<
     )
   }
 
+  // te
+  function te(key: Path, locale?: Locale): boolean {
+    const targetLocale = isString(locale) ? locale : _locale.value
+    const message = getLocaleMessage(targetLocale)
+    return resolveValue(message, key) !== null
+  }
+
   // tm
   function tm(key: Path): LocaleMessageValue<Message> | {} {
     const messages = _messages.value[_locale.value] || {}
@@ -1605,6 +1626,7 @@ export function createComposer<
     t,
     d,
     n,
+    te,
     tm,
     getLocaleMessage,
     setLocaleMessage,

diff --git a/src/legacy.ts b/src/legacy.ts
@@ -643,17 +643,15 @@ export interface VueI18n<
   /** @internal */
   tc(...args: unknown[]): TranslateResult // for $tc
   /**
-   * Translation message exist
+   * Translation locale message exist
    *
    * @remarks
-   * Check whether key exists.
-   *
-   * In Vue instance, If not specified locale messages on i18n component options component locale messages, check with global scope locale messages.
+   * whether do exist locale message on VueI18n instance [messages](legacy#messages).
    *
    * If you specified `locale`, check the locale messages of `locale`.
    *
    * @param key - A target locale message key
-   * @param locale - A locale, it will be used over than global scope or local scope.
+   * @param locale - A target locale
    *
    * @returns If found locale message, `true`, else `false`
    */
@@ -1255,9 +1253,7 @@ export function createVueI18n<
 
     // te
     te(key: Path, locale?: Locale): boolean {
-      const targetLocale = isString(locale) ? locale : composer.locale.value
-      const message = composer.getLocaleMessage(targetLocale)
-      return resolveValue(message, key) !== null
+      return composer.te(key, locale)
     },
 
     // tm

diff --git a/test/composer.test.ts b/test/composer.test.ts
@@ -772,6 +772,23 @@ test('tm', async () => {
   expect(messages2).toEqual({})
 })
 
+test('te', async () => {
+  const { te } = createComposer({
+    locale: 'en',
+    messages: {
+      en: {
+        message: {
+          hello: 'Hello!'
+        }
+      }
+    }
+  })
+
+  expect(te('message.hello')).toEqual(true)
+  expect(te('message.hallo')).toEqual(false)
+  expect(te('message.hallo', 'ja')).toEqual(false)
+})
+
 describe('getLocaleMessage / setLocaleMessage / mergeLocaleMessage', () => {
   test('basic', () => {
     const {