docs: add return explanation for te (#1738)

Author: kazupon

package.json

@@ -48,7 +48,7 @@
     "fix": "run-p lint:fix format:fix",
     "format:fix": "run-p \"format:prettier --write\" format:package",
     "format:package": "node -r esbuild-register ./scripts/fixpack.ts",
-    "format:prettier": "prettier --config prettier.config.mjs --ignore-path .prettierignore --list-different '**/*.{js,json,html}'",
+    "format:prettier": "prettier --config prettier.config.mjs --ignore-path .prettierignore --list-different '**/*.{ts,js,json,html}'",
     "lint": "run-p lint:secret lint:codes lint:docs",
     "lint:codes": "eslint --cache ./packages ./test-dts ./e2e ./benchmark --ext .js,.mjs,.ts,.vue",
     "lint:docs": "textlint --config .textlintrc.js docs/*.md docs/advanced/**/*.md docs/essentials/**/*.md docs/migration/**/*.md docs/api/injection.md packages/**/*.md",

packages/petite-vue-i18n/src/vue.d.ts

@@ -864,7 +864,7 @@ declare module '@vue/runtime-core' {
      * @param key - A target locale message key
      * @param locale - A locale, optional, override locale that global scope or local scope
      *
-     * @returns if found locale message, `true`, else `false`
+     * @returns If found locale message, `true`, else `false`, Note that `false` is returned even if the value present in the Key is not translatable.
      */
     $te<
       Key extends string,

packages/vue-i18n-bridge/src/vue.d.ts

@@ -869,7 +869,7 @@ declare module '@vue/runtime-core' {
      * @param key - A target locale message key
      * @param locale - A locale, optional, override locale that global scope or local scope
      *
-     * @returns if found locale message, `true`, else `false`
+     * @returns If found locale message, `true`, else `false`, Note that `false` is returned even if the value present in the Key is not translatable.
      */
     $te<
       Key extends string,

packages/vue-i18n-core/src/composer.ts

@@ -264,36 +264,36 @@ export interface ComposerOptions<
     number: DefaultNumberFormatSchema
   },
   Locales extends
-    | {
-        messages: unknown
-        datetimeFormats: unknown
-        numberFormats: unknown
-      }
-    | string = Locale,
+  | {
+    messages: unknown
+    datetimeFormats: unknown
+    numberFormats: unknown
+  }
+  | string = Locale,
   MessagesLocales = Locales extends { messages: infer M }
-    ? M
-    : Locales extends string
-    ? Locales
-    : Locale,
+  ? M
+  : Locales extends string
+  ? Locales
+  : Locale,
   DateTimeFormatsLocales = Locales extends { datetimeFormats: infer D }
-    ? D
-    : Locales extends string
-    ? Locales
-    : Locale,
+  ? D
+  : Locales extends string
+  ? Locales
+  : Locale,
   NumberFormatsLocales = Locales extends { numberFormats: infer N }
-    ? N
-    : Locales extends string
-    ? Locales
-    : Locale,
+  ? N
+  : Locales extends string
+  ? Locales
+  : Locale,
   MessageSchema = Schema extends { message: infer M }
-    ? M
-    : DefaultLocaleMessageSchema,
+  ? M
+  : DefaultLocaleMessageSchema,
   DateTimeSchema = Schema extends { datetime: infer D }
-    ? D
-    : DefaultDateTimeFormatSchema,
+  ? D
+  : DefaultDateTimeFormatSchema,
   NumberSchema = Schema extends { number: infer N }
-    ? N
-    : DefaultNumberFormatSchema,
+  ? N
+  : DefaultNumberFormatSchema,
   _Messages extends LocaleMessages<
     MessageSchema,
     MessagesLocales,
@@ -654,8 +654,8 @@ export interface ComposerTranslation<
       ? C | M
       : C
     : IsNever<M> extends false
-    ? M
-    : never
+      ? M
+      : never
 > {
   /**
    * Locale message translation
@@ -1001,8 +1001,8 @@ export interface ComposerDateTimeFormatting<
       ? C | M
       : C
     : IsNever<M> extends false
-    ? M
-    : never
+      ? M
+      : never
 > {
   /**
    * Datetime formatting
@@ -1091,8 +1091,8 @@ export interface ComposerNumberFormatting<
       ? C | M
       : C
     : IsNever<M> extends false
-    ? M
-    : never
+      ? M
+      : never
 > {
   /**
    * Number Formatting
@@ -1383,7 +1383,7 @@ export interface Composer<
    * @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`
+   * @returns If found locale message, `true`, else `false`, Note that `false` is returned even if the value present in the Key is not translatable.
    */
   te<
     Str extends string,
@@ -1895,19 +1895,19 @@ export function createComposer(options: any = {}, VueI18nLegacy?: any): any {
   // prettier-ignore
   const _datetimeFormats = !__LITE__
     ? _ref<DateTimeFormatsType>(
-        isPlainObject(options.datetimeFormats)
-          ? options.datetimeFormats
-          : { [_locale.value]: {} }
-      )
+      isPlainObject(options.datetimeFormats)
+        ? options.datetimeFormats
+        : { [_locale.value]: {} }
+    )
     : /* #__PURE__*/ ref<DateTimeFormatsType>({})
 
   // prettier-ignore
   const _numberFormats = !__LITE__
     ? _ref<NumberFormatsType>(
-        isPlainObject(options.numberFormats)
-          ? options.numberFormats
-          : { [_locale.value]: {} }
-      )
+      isPlainObject(options.numberFormats)
+        ? options.numberFormats
+        : { [_locale.value]: {} }
+    )
     : /* #__PURE__*/ _ref<NumberFormatsType>({})
 
   // warning suppress options

packages/vue-i18n/src/vue.d.ts

@@ -869,7 +869,7 @@ declare module '@vue/runtime-core' {
      * @param key - A target locale message key
      * @param locale - A locale, optional, override locale that global scope or local scope
      *
-     * @returns if found locale message, `true`, else `false`
+     * @returns If found locale message, `true`, else `false`, Note that `false` is returned even if the value present in the Key is not translatable.
      */
     $te<
       Key extends string,