chore: mark type as internal

Author: posva

src/core/utils.ts

@@ -3,7 +3,11 @@ import type { RouteRecordOverride, TreeRouteParam } from './treeNodeValue'
 import { pascalCase } from 'scule'
 import { ResolvedOptions, RoutesFolderOption } from '../options'
 
-export type Awaitable<T> = T | PromiseLike<T>
+/**
+ * Maybe a promise maybe not
+ * @internal
+ */
+export type _Awaitable<T> = T | PromiseLike<T>
 
 export type LiteralStringUnion<LiteralType, BaseType extends string = string> =
   | LiteralType

src/data-fetching/dataFetchingGuard.ts

@@ -1,6 +1,6 @@
 import { DataLoader, isDataLoader } from './defineLoader'
 import type { RouteLocationNormalized, Router } from 'vue-router'
-import { Awaitable } from '../core/utils'
+import { _Awaitable } from '../core/utils'
 
 // Symbol used to detect if a route has loaders
 export const HasDataLoaderMeta = Symbol()
@@ -40,7 +40,7 @@ export interface SetupDataFetchingGuardOptions {
    */
   selectNavigationResult?: (
     results: NavigationResult[]
-  ) => Awaitable<NavigationResult | undefined | void>
+  ) => _Awaitable<NavigationResult | undefined | void>
 }
 
 export function setupDataFetchingGuard(

src/options.ts

@@ -1,5 +1,5 @@
 import { isPackageExists } from 'local-pkg'
-import { Awaitable, getFileBasedRouteName, isArray, warn } from './core/utils'
+import { _Awaitable, getFileBasedRouteName, isArray, warn } from './core/utils'
 import type { TreeNode } from './core/tree'
 import { resolve } from 'pathe'
 import { EditableTreeNode } from './core/extendRoutes'
@@ -121,7 +121,7 @@ export interface ResolvedOptions {
    *
    * @param route - {@link EditableTreeNode} of the route to extend
    */
-  extendRoute?: (route: EditableTreeNode) => Awaitable<void>
+  extendRoute?: (route: EditableTreeNode) => _Awaitable<void>
 
   /**
    * Allows to do some changes before writing the files. This will be invoked **every time** the files need to be written.
@@ -130,7 +130,7 @@ export interface ResolvedOptions {
    *
    * @param rootRoute - {@link EditableTreeNode} of the root route
    */
-  beforeWriteFiles?: (rootRoute: EditableTreeNode) => Awaitable<void>
+  beforeWriteFiles?: (rootRoute: EditableTreeNode) => _Awaitable<void>
 
   /**
    * Enables EXPERIMENTAL data fetching. See https://github.com/posva/unplugin-vue-router/tree/main/src/data-fetching