@real-router/types 0.16.0 → 0.17.0

package/dist/cjs/index.d.ts

@@ -109,7 +109,6 @@ interface RouterError extends Error {
  * @see {@link State.meta} for where options are stored after navigation
  */
 interface NavigationOptions {
-    [key: string]: string | number | boolean | Record<string, unknown> | undefined;
     /**
      * Replace the current history entry instead of pushing a new one.
      *
@@ -245,6 +244,17 @@ interface NavigationOptions {
      * @see {@link NavigationOptions.redirected} for the input mechanism
      */
     redirected?: boolean | undefined;
+    /**
+     * Optional abort signal for cancelling the navigation.
+     *
+     * @description
+     * When provided, this signal can be used to cancel the navigation operation.
+     * If the signal is aborted, the navigation will be cancelled and any pending
+     * guards or transitions will be interrupted.
+     *
+     * @default undefined
+     */
+    signal?: AbortSignal | undefined;
 }
 interface Params {
     [key: string]: string | string[] | number | number[] | boolean | boolean[] | Params | Params[] | Record<string, string | number | boolean> | null | undefined;
@@ -416,7 +426,7 @@ interface Options {
      */
     noValidate?: boolean;
 }
-type GuardFn = (toState: State, fromState: State | undefined) => boolean | Promise<boolean>;
+type GuardFn = (toState: State, fromState: State | undefined, signal?: AbortSignal) => boolean | Promise<boolean>;
 type DefaultDependencies = object;
 interface Config {
     decoders: Record<string, (params: Params) => Params>;

package/dist/esm/index.d.mts

@@ -109,7 +109,6 @@ interface RouterError extends Error {
  * @see {@link State.meta} for where options are stored after navigation
  */
 interface NavigationOptions {
-    [key: string]: string | number | boolean | Record<string, unknown> | undefined;
     /**
      * Replace the current history entry instead of pushing a new one.
      *
@@ -245,6 +244,17 @@ interface NavigationOptions {
      * @see {@link NavigationOptions.redirected} for the input mechanism
      */
     redirected?: boolean | undefined;
+    /**
+     * Optional abort signal for cancelling the navigation.
+     *
+     * @description
+     * When provided, this signal can be used to cancel the navigation operation.
+     * If the signal is aborted, the navigation will be cancelled and any pending
+     * guards or transitions will be interrupted.
+     *
+     * @default undefined
+     */
+    signal?: AbortSignal | undefined;
 }
 interface Params {
     [key: string]: string | string[] | number | number[] | boolean | boolean[] | Params | Params[] | Record<string, string | number | boolean> | null | undefined;
@@ -416,7 +426,7 @@ interface Options {
      */
     noValidate?: boolean;
 }
-type GuardFn = (toState: State, fromState: State | undefined) => boolean | Promise<boolean>;
+type GuardFn = (toState: State, fromState: State | undefined, signal?: AbortSignal) => boolean | Promise<boolean>;
 type DefaultDependencies = object;
 interface Config {
     decoders: Record<string, (params: Params) => Params>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@real-router/types",
-  "version": "0.16.0",
+  "version": "0.17.0",
   "type": "commonjs",
   "description": "Shared TypeScript types for Real Router ecosystem",
   "types": "./dist/esm/index.d.mts",

package/src/base.ts

@@ -86,13 +86,6 @@ export interface RouterError extends Error {
  * @see {@link State.meta} for where options are stored after navigation
  */
 export interface NavigationOptions {
-  [key: string]:
-    | string
-    | number
-    | boolean
-    | Record<string, unknown>
-    | undefined;
-
   /**
    * Replace the current history entry instead of pushing a new one.
    *
@@ -232,6 +225,18 @@ export interface NavigationOptions {
    * @see {@link NavigationOptions.redirected} for the input mechanism
    */
   redirected?: boolean | undefined;
+
+  /**
+   * Optional abort signal for cancelling the navigation.
+   *
+   * @description
+   * When provided, this signal can be used to cancel the navigation operation.
+   * If the signal is aborted, the navigation will be cancelled and any pending
+   * guards or transitions will be interrupted.
+   *
+   * @default undefined
+   */
+  signal?: AbortSignal | undefined;
 }
 
 export interface Params {

package/src/router.ts

@@ -158,6 +158,7 @@ export interface Options {
 export type GuardFn = (
   toState: State,
   fromState: State | undefined,
+  signal?: AbortSignal,
 ) => boolean | Promise<boolean>;
 
 export type DefaultDependencies = object;