nuxt-typed-router 2.2.2-beta.0 → 2.2.2-beta.1

package/dist/module.d.ts

@@ -7,26 +7,54 @@ interface ModuleOptions {
      */
     plugin?: boolean;
     /**
-     * Prevent passing a string path to `router` or `<NuxtLink/>`
-     * Ex:
+     * Customise Route location arguments strictness for `NuxtLink` or `router`
+     * All strict options are disabled by default.
+     * You can tweak options to add strict router navigation options.
+     *
+     * By passing `true` you can enable all of them
      *
-     * ```ts
-     * router.push('/login'); // Error ❌
-     * ```
      * @default false
      */
     strict?: boolean | StrictOptions;
 }
 interface StrictOptions {
-    NuxtLink: StrictParamsOptions;
-    router: StrictParamsOptions;
+    NuxtLink?: StrictParamsOptions;
+    router?: StrictParamsOptions;
 }
 interface StrictParamsOptions {
     /**
+     * Prevent passing string path to the RouteLocation argument.
+     *
+     * Ex:
+     * ```vue
+     * <template>
+     *   <NuxtLink to='/login'/> // Error ❌
+     * </template>
+     * ```
+     * Or
+     * ```ts
+     * router.push('/login'); // Error ❌
+     * navigateTo('/login'); // Error ❌
+     * ```
+     *
      * @default false
      */
     strictToArgument?: boolean;
     /**
+     * Prevent passing a `params` property in the RouteLocation argument.
+     *
+     * Ex:
+     * ```vue
+     * <template>
+     *   <NuxtLink :to='{path: "/login"}'/> // Error ❌
+     * </template>
+     * ```
+     * Or
+     * ```ts
+     * router.push({path: "/login"}); // Error ❌
+     * navigateTo({path: "/login"}); // Error ❌
+     * ```
+     *
      * @default false
      */
     strictRouteLocation?: boolean;

package/dist/module.json

@@ -5,5 +5,5 @@
     "nuxt": "^3.0.0-rc.1",
     "bridge": false
   },
-  "version": "2.2.2-beta.0"
+  "version": "2.2.2-beta.1"
 }

package/dist/module.mjs

@@ -228,10 +228,10 @@ function createTypedRouterFile() {
    * */
   export type TypedRouteLocationRaw =
   | (Omit<Exclude<RouteLocationRaw, string>, 'name' | 'params' ${returnIfTrue(
-      strictOptions.NuxtLink.strictRouteLocation,
+      strictOptions.router.strictRouteLocation,
       `| 'path'`
     )}> & RoutesNamedLocations)
-  ${returnIfFalse(strictOptions.NuxtLink.strictToArgument, "| string")};
+  ${returnIfFalse(strictOptions.router.strictToArgument, "| string")};
   
 
   /**
@@ -239,10 +239,10 @@ function createTypedRouterFile() {
    */
   export type TypedRouteLocationRawFromName<T extends RoutesNamesList> =
   | (Omit<Exclude<RouteLocationRaw, string>, 'name' | 'params' ${returnIfTrue(
-      strictOptions.NuxtLink.strictRouteLocation,
+      strictOptions.router.strictRouteLocation,
       `| 'path'`
     )}> & TypedLocationAsRelativeRaw<T>)
-  ${returnIfFalse(strictOptions.NuxtLink.strictToArgument, "| string")};
+  ${returnIfFalse(strictOptions.router.strictToArgument, "| string")};
 
   /** 
    * Generic providing inference and dynamic inclusion of \`params\` property

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nuxt-typed-router",
-  "version": "2.2.2-beta.0",
+  "version": "2.2.2-beta.1",
   "description": "Provide autocompletion for pages route names generated by Nuxt router",
   "type": "module",
   "main": "./dist/module.cjs",