⬅️ Back to Table of Contents

📄 _types.ts

📊 Analysis Summary

Metric	Count
📦 Imports	4
📐 Interfaces	2
📑 Type Aliases	2

📚 Table of Contents

• Imports
• Interfaces
• Type Aliases

🛠️ File Location:

📂 packages/router/_types.ts

📦 Imports

Name	Source
MaybeRef	vue
RouteParamValueRaw	vue-router
useRoute	vue-router
useRouter	vue-router

---

Interfaces

ReactiveRouteOptions

Interface Code

export interface ReactiveRouteOptions {
  /**
   * Mode to update the router query, ref is also acceptable
   *
   * @default 'replace'
   */
  mode?: MaybeRef<'replace' | 'push'>

  /**
   * Route instance, use `useRoute()` if not given
   */
  route?: ReturnType<typeof useRoute>

  /**
   * Router instance, use `useRouter()` if not given
   */
  router?: ReturnType<typeof useRouter>
}

Properties

Name	Type	Optional	Description
mode	MaybeRef<'replace' | 'push'>	✓
route	ReturnType<typeof useRoute>	✓
router	ReturnType<typeof useRouter>	✓

ReactiveRouteOptionsWithTransform<V, R>

Interface Code

export interface ReactiveRouteOptionsWithTransform<V, R> extends ReactiveRouteOptions {
  /**
   * Function to transform data before return, or an object with one or both functions:
   * `get` to transform data before returning, and `set` to transform data before setting
   */
  transform?:
    | ((val: V) => R)
    | ({
      get?: (value: V) => R
      set?: (value: R) => V
    })
}

Properties

Name	Type	Optional	Description
transform	`	((val: V) => R)
({
get?: (value: V) => R
set?: (value: R) => V
})`	✓

---

Type Aliases

RouteQueryValueRaw

type RouteQueryValueRaw = RouteParamValueRaw | string[];

RouteHashValueRaw

type RouteHashValueRaw = string | null | undefined;

---