@react-navigation/routers 7.5.3 → 8.0.0-alpha.1

package/src/types.tsx

@@ -64,35 +64,42 @@ export type PartialState<State extends NavigationState> = Partial<
 
 export type Route<
   RouteName extends string,
-  Params extends object | undefined = object | undefined,
-> = Readonly<{
-  /**
-   * Unique key for the route.
-   */
-  key: string;
-  /**
-   * User-provided name for the route.
-   */
-  name: RouteName;
-  /**
-   * Path associated with the route.
-   * Usually present when the screen was opened from a deep link.
-   */
-  path?: string;
-}> &
-  (undefined extends Params
-    ? Readonly<{
-        /**
-         * Params for this route
-         */
-        params?: Readonly<Params>;
-      }>
-    : Readonly<{
-        /**
-         * Params for this route
-         */
-        params: Readonly<Params>;
-      }>);
+  Params extends unknown | object | undefined = object | undefined,
+> = Readonly<
+  {
+    /**
+     * Unique key for the route.
+     */
+    key: string;
+    /**
+     * User-provided name for the route.
+     */
+    name: RouteName;
+    /**
+     * Path associated with the route.
+     * Usually present when the screen was opened from a deep link.
+     */
+    path?: string;
+    /**
+     * History of param changes for this route.
+     */
+    history?: { type: 'params'; params: object }[];
+  } & Readonly<
+    undefined extends Params
+      ? {
+          /**
+           * Params for this route
+           */
+          params?: Readonly<Params>;
+        }
+      : {
+          /**
+           * Params for this route
+           */
+          params: Readonly<Params>;
+        }
+  >
+>;
 
 export type ParamListBase = Record<string, object | undefined>;
 
@@ -221,6 +228,17 @@ export type Router<
    */
   shouldActionChangeFocus(action: NavigationAction): boolean;
 
+  /**
+   * Get the list of routes from the navigation state.
+   *
+   * By default, `state.routes` is used.
+   * But in some cases (like `preloadedRoutes` in stack),
+   * the actual list of routes may be different.
+   *
+   * @param state Navigation state to get the routes from.
+   */
+  getRoutesFromState?(state: State): Route<string>[];
+
   /**
    * Action creators for the router.
    */