navigation-stack 0.5.0 → 0.5.1

package/data-storage/package.json

@@ -2,5 +2,6 @@
   "private": true,
   "name": "navigation-stack/data-storage",
   "main": "./../lib/cjs/data-storage/index.js",
-  "module": "./../lib/esm/data-storage/index.js"
+  "module": "./../lib/esm/data-storage/index.js",
+  "types": "./../lib/data-storage/index.d.ts"
 }

package/lib/cjs/scroll-position/ScrollPositionRestoration.js

@@ -133,11 +133,11 @@ class ScrollPositionRestoration {
       // This function is only used in tests.
       // There seems to be no use of it in real life, hence it's not public API.
       // It's only used in tests.
-      _getScrollPositionForLocation: _options && _options._getPageScrollPositionForLocation,
+      _getSavedScrollPositionOnLocationChange: _options && _options._getSavedPageScrollPositionOnLocationChange,
       // This function is only used in tests.
       // There seems to be no use of it in real life, hence it's not public API.
       // It's only used in tests.
-      _shouldUpdateScrollPositionForLocation: _options && _options._shouldUpdatePageScrollPositionForLocation
+      _shouldSetScrollPositionOnLocationChange: _options && _options._shouldSetPageScrollPositionOnLocationChange
     };
   }
   addScrollableContainer(scrollableContainerKey, scrollableContainer, _options) {
@@ -172,11 +172,11 @@ class ScrollPositionRestoration {
       // This function is only used in tests.
       // There seems to be no use of it in real life, hence it's not public API.
       // It's only used in tests.
-      _shouldUpdateScrollPositionForLocation: _options && _options._shouldUpdateScrollPositionForLocation,
+      _shouldSetScrollPositionOnLocationChange: _options && _options._shouldSetScrollPositionOnLocationChange,
       // This function is only used in tests.
       // There seems to be no use of it in real life, hence it's not public API.
       // It's only used in tests.
-      _getScrollPositionForLocation: _options && _options._getScrollPositionForLocation
+      _getSavedScrollPositionOnLocationChange: _options && _options._getSavedScrollPositionOnLocationChange
     };
 
     // Scrollable containers could be added at any time, including page mount.
@@ -334,8 +334,8 @@ class ScrollPositionRestoration {
       // This function is only used in tests.
       // There seems to be no use of it in real life, hence it's not public API.
       // It's only used in tests.
-      if (scrollableContainerEntry._shouldUpdateScrollPositionForLocation) {
-        if (!scrollableContainerEntry._shouldUpdateScrollPositionForLocation(this._location, this._prevLocation)) {
+      if (scrollableContainerEntry._shouldSetScrollPositionOnLocationChange) {
+        if (!scrollableContainerEntry._shouldSetScrollPositionOnLocationChange(this._location, this._prevLocation)) {
           return Promise.resolve();
         }
       }
@@ -346,8 +346,8 @@ class ScrollPositionRestoration {
       // This function is only used in tests.
       // There seems to be no use of it in real life, hence it's not public API.
       // It's only used in tests.
-      if (scrollableContainerEntry._getScrollPositionForLocation) {
-        scrollPositionOrAnchorToSet = scrollableContainerEntry._getScrollPositionForLocation(this._location, this._prevLocation);
+      if (scrollableContainerEntry._getSavedScrollPositionOnLocationChange) {
+        scrollPositionOrAnchorToSet = scrollableContainerEntry._getSavedScrollPositionOnLocationChange(this._location, this._prevLocation);
       }
 
       // Get scroll position (or anchor) to set.

package/lib/esm/scroll-position/ScrollPositionRestoration.js

@@ -128,11 +128,11 @@ export default class ScrollPositionRestoration {
       // This function is only used in tests.
       // There seems to be no use of it in real life, hence it's not public API.
       // It's only used in tests.
-      _getScrollPositionForLocation: _options && _options._getPageScrollPositionForLocation,
+      _getSavedScrollPositionOnLocationChange: _options && _options._getSavedPageScrollPositionOnLocationChange,
       // This function is only used in tests.
       // There seems to be no use of it in real life, hence it's not public API.
       // It's only used in tests.
-      _shouldUpdateScrollPositionForLocation: _options && _options._shouldUpdatePageScrollPositionForLocation
+      _shouldSetScrollPositionOnLocationChange: _options && _options._shouldSetPageScrollPositionOnLocationChange
     };
   }
   addScrollableContainer(scrollableContainerKey, scrollableContainer, _options) {
@@ -167,11 +167,11 @@ export default class ScrollPositionRestoration {
       // This function is only used in tests.
       // There seems to be no use of it in real life, hence it's not public API.
       // It's only used in tests.
-      _shouldUpdateScrollPositionForLocation: _options && _options._shouldUpdateScrollPositionForLocation,
+      _shouldSetScrollPositionOnLocationChange: _options && _options._shouldSetScrollPositionOnLocationChange,
       // This function is only used in tests.
       // There seems to be no use of it in real life, hence it's not public API.
       // It's only used in tests.
-      _getScrollPositionForLocation: _options && _options._getScrollPositionForLocation
+      _getSavedScrollPositionOnLocationChange: _options && _options._getSavedScrollPositionOnLocationChange
     };
 
     // Scrollable containers could be added at any time, including page mount.
@@ -329,8 +329,8 @@ export default class ScrollPositionRestoration {
       // This function is only used in tests.
       // There seems to be no use of it in real life, hence it's not public API.
       // It's only used in tests.
-      if (scrollableContainerEntry._shouldUpdateScrollPositionForLocation) {
-        if (!scrollableContainerEntry._shouldUpdateScrollPositionForLocation(this._location, this._prevLocation)) {
+      if (scrollableContainerEntry._shouldSetScrollPositionOnLocationChange) {
+        if (!scrollableContainerEntry._shouldSetScrollPositionOnLocationChange(this._location, this._prevLocation)) {
           return Promise.resolve();
         }
       }
@@ -341,8 +341,8 @@ export default class ScrollPositionRestoration {
       // This function is only used in tests.
       // There seems to be no use of it in real life, hence it's not public API.
       // It's only used in tests.
-      if (scrollableContainerEntry._getScrollPositionForLocation) {
-        scrollPositionOrAnchorToSet = scrollableContainerEntry._getScrollPositionForLocation(this._location, this._prevLocation);
+      if (scrollableContainerEntry._getSavedScrollPositionOnLocationChange) {
+        scrollPositionOrAnchorToSet = scrollableContainerEntry._getSavedScrollPositionOnLocationChange(this._location, this._prevLocation);
       }
 
       // Get scroll position (or anchor) to set.

package/lib/scroll-position/index.d.ts

@@ -15,18 +15,18 @@ export class ScrollPositionRestoration<
 
     // `_options` are currently only used in tests.
     _options?: {
-      // `_options._shouldUpdatePageScrollPositionForLocation`
+      // `_options._shouldSetPageScrollPositionOnLocationChange`
       // isn't used in real life and is not part of the public API.
       // It's only used in tests.
-      _shouldUpdatePageScrollPositionForLocation?: (
+      _shouldSetPageScrollPositionOnLocationChange?: (
         location: Location,
         prevLocation: Location | undefined,
       ) => boolean;
 
-      // `_options._getPageScrollPositionForLocation`
+      // `_options._getSavedPageScrollPositionOnLocationChange`
       // isn't used in real life and is not part of the public API.
       // It's only used in tests.
-      _getPageScrollPositionForLocation?: (
+      _getSavedPageScrollPositionOnLocationChange?: (
         location: Location,
         prevLocation: Location | undefined,
       ) => [number, number] | undefined;
@@ -47,18 +47,18 @@ export class ScrollPositionRestoration<
 
     // `_options` are currently only used in tests.
     _options?: {
-      // `_options._shouldUpdateScrollPositionForLocation`
+      // `_options._shouldSetScrollPositionOnLocationChange`
       // isn't used in real life and is not part of the public API.
       // It's only used in tests.
-      _shouldUpdateScrollPositionForLocation?: (
+      _shouldSetScrollPositionOnLocationChange?: (
         location: Location,
         prevLocation: Location | undefined,
       ) => boolean;
 
-      // `_options._getScrollPositionForLocation`
+      // `_options._getSavedScrollPositionOnLocationChange`
       // isn't used in real life and is not part of the public API.
       // It's only used in tests.
-      _getScrollPositionForLocation?: (
+      _getSavedScrollPositionOnLocationChange?: (
         location: Location,
         prevLocation: Location | undefined,
       ) => [number, number] | undefined;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "navigation-stack",
-  "version": "0.5.0",
+  "version": "0.5.1",
   "description": "Handles navigation in a web browser",
   "keywords": [
     "history",

package/redux/package.json

@@ -2,5 +2,6 @@
   "private": true,
   "name": "navigation-stack/redux",
   "main": "./../lib/cjs/redux/index.js",
-  "module": "./../lib/esm/redux/index.js"
+  "module": "./../lib/esm/redux/index.js",
+  "types": "./../lib/redux/index.d.ts"
 }

package/scroll-position/package.json

@@ -2,5 +2,6 @@
   "private": true,
   "name": "navigation-stack/scroll-position",
   "main": "./../lib/cjs/scroll-position/index.js",
-  "module": "./../lib/esm/scroll-position/index.js"
+  "module": "./../lib/esm/scroll-position/index.js",
+  "types": "./../lib/scroll-position/index.d.ts"
 }

package/src/scroll-position/ScrollPositionRestoration.js

@@ -59,14 +59,14 @@ export default class ScrollPositionRestoration {
       // This function is only used in tests.
       // There seems to be no use of it in real life, hence it's not public API.
       // It's only used in tests.
-      _getScrollPositionForLocation:
-        _options && _options._getPageScrollPositionForLocation,
+      _getSavedScrollPositionOnLocationChange:
+        _options && _options._getSavedPageScrollPositionOnLocationChange,
 
       // This function is only used in tests.
       // There seems to be no use of it in real life, hence it's not public API.
       // It's only used in tests.
-      _shouldUpdateScrollPositionForLocation:
-        _options && _options._shouldUpdatePageScrollPositionForLocation,
+      _shouldSetScrollPositionOnLocationChange:
+        _options && _options._shouldSetPageScrollPositionOnLocationChange,
     };
   }
 
@@ -114,14 +114,14 @@ export default class ScrollPositionRestoration {
       // This function is only used in tests.
       // There seems to be no use of it in real life, hence it's not public API.
       // It's only used in tests.
-      _shouldUpdateScrollPositionForLocation:
-        _options && _options._shouldUpdateScrollPositionForLocation,
+      _shouldSetScrollPositionOnLocationChange:
+        _options && _options._shouldSetScrollPositionOnLocationChange,
 
       // This function is only used in tests.
       // There seems to be no use of it in real life, hence it's not public API.
       // It's only used in tests.
-      _getScrollPositionForLocation:
-        _options && _options._getScrollPositionForLocation,
+      _getSavedScrollPositionOnLocationChange:
+        _options && _options._getSavedScrollPositionOnLocationChange,
     };
 
     // Scrollable containers could be added at any time, including page mount.
@@ -390,9 +390,11 @@ export default class ScrollPositionRestoration {
         // This function is only used in tests.
         // There seems to be no use of it in real life, hence it's not public API.
         // It's only used in tests.
-        if (scrollableContainerEntry._shouldUpdateScrollPositionForLocation) {
+        if (
+          scrollableContainerEntry._shouldSetScrollPositionOnLocationChange
+        ) {
           if (
-            !scrollableContainerEntry._shouldUpdateScrollPositionForLocation(
+            !scrollableContainerEntry._shouldSetScrollPositionOnLocationChange(
               this._location,
               this._prevLocation,
             )
@@ -407,9 +409,9 @@ export default class ScrollPositionRestoration {
         // This function is only used in tests.
         // There seems to be no use of it in real life, hence it's not public API.
         // It's only used in tests.
-        if (scrollableContainerEntry._getScrollPositionForLocation) {
+        if (scrollableContainerEntry._getSavedScrollPositionOnLocationChange) {
           scrollPositionOrAnchorToSet =
-            scrollableContainerEntry._getScrollPositionForLocation(
+            scrollableContainerEntry._getSavedScrollPositionOnLocationChange(
               this._location,
               this._prevLocation,
             );

package/test/NavigationStack.test.js

@@ -255,42 +255,145 @@ describe('NavigationStack', () => {
       index: 1,
     });
   });
+});
+
+describe('NavigationStack (maintainScrollPosition: true)', () => {
+  let navigationStack;
+
+  afterEach(() => {
+    // Even if a test errors, the `NavigationStack` should still be stopped
+    // in order to remove the potential "popstate" listener so that it doesn't
+    // interfere with other tests.
+    //
+    // `navigationStack.stop()` method is "idempotent", i.e. it can be called multiple times.
+    //
+    navigationStack.stop();
+  });
 
   it('should support `maintainScrollPosition: true` option', async () => {
     navigationStack = new NavigationStack(new WebBrowserSession(), {
       maintainScrollPosition: true,
     });
 
+    // Start with the "/initial" page.
+    window.history.replaceState(null, null, '/initial');
+
+    // Initialize `NavigationStack`.
     navigationStack.init();
 
-    navigationStack.locationRendered();
+    // "/initial" page rendered.
+    // Restore scroll position (no saved scroll position to restore).
+    await navigationStack.locationRendered();
 
-    navigationStack.push('/new');
+    // Create a content <div/> that "overflows" the window so that it becomes scrollable.
+    const content = document.createElement('div');
+    content.style.height = '10000px';
+    content.style.width = '10000px';
+    document.body.appendChild(content);
 
-    navigationStack.locationRendered();
+    // Scroll the page to some position.
+    // The scroll position will be saved.
+    window.scrollTo(0, 1000);
+
+    // Check that it has scrolled to that position.
+    expect(window.pageYOffset).to.be.closeTo(1000, 0.5);
+
+    // Wait a bit for `ScrollPositionRestoration` to save the scroll position
+    // because it does that "asynchronously", i.e. in an "immediate" timeout
+    // as a way of "throttling" scroll events.
+    await delay(20);
+
+    // Go to "/new" page.
+    navigationStack.push('/new');
 
+    // Create a scrollable container to test its scroll position restoration later.
     const scrollableContainer = document.createElement('div');
+    scrollableContainer.style.height = '100px';
+    scrollableContainer.style.width = '100px';
+    // With default `overflow` value, the scrollable container won't become scrollable
+    // and will simply stretch vertically according to the child content.
+    scrollableContainer.style.overflow = 'auto';
+    // "Overflow" the scrollable container with nested content so that it becomes scrollable.
+    scrollableContainer.innerHTML = '<div style="height: 10000px"></div>';
     document.body.appendChild(scrollableContainer);
 
-    const removeScrollableContainer = navigationStack.addScrollableContainer(
+    // "/new" page rendered.
+    // Restore scroll position (no saved scroll position to restore).
+    await navigationStack.locationRendered();
+
+    // It should've reset page scroll position.
+    expect(window.pageYOffset).to.equal(0);
+
+    // Scroll the page to some position.
+    // The scroll position will be saved.
+    window.scrollTo(0, 500);
+
+    // Check that it has scrolled to that position.
+    expect(window.pageYOffset).to.be.closeTo(500, 0.5);
+
+    // Scroll inside the scrollable container to see if the scroll position
+    // is restored later when revisiting this page.
+    scrollableContainer.scrollTo(0, 1000);
+
+    // Check that it has scrolled to that position.
+    expect(scrollableContainer.scrollTop).to.be.closeTo(1000, 0.5);
+
+    // Wait a bit for `ScrollPositionRestoration` to save the scroll position
+    // because it does that "asynchronously", i.e. in an "immediate" timeout
+    // as a way of "throttling" scroll events.
+    await delay(20);
+
+    // Register the scrollable container on the "/new" page.
+    const untrackScrollableContainer = navigationStack.addScrollableContainer(
       'container',
       scrollableContainer,
     );
 
-    // `PageScrollPositionSetter` works in an asynchronous fashion,
-    // so this delay lets it finish setting page scroll position
-    // before proceeding to next location.
-    await delay(20);
+    // Go to "/new-2" page to check that it resets the scroll position inside the scrollable container.
+    navigationStack.push('/new-2');
+
+    // "/new-2" page rendered.
+    // Restore scroll position (no saved scroll position to restore).
+    await navigationStack.locationRendered();
 
-    removeScrollableContainer();
+    // Check that it has reset the scroll position inside the scrollable container.
+    expect(scrollableContainer.scrollTop).to.equal(0);
 
+    // It should also reset page scroll position on any "push" navigation.
+    expect(window.pageYOffset).to.equal(0);
+
+    // Return to the "/new" page to check if it restores scroll position inside the scrollable container.
     navigationStack.shift(-1);
 
-    navigationStack.locationRendered();
+    // Wait for the web browser to emit a "popstate" event from `window.history.go(-1)` navigation.
+    await delay(20);
+
+    // "/new" page rendered.
+    // Restore scroll position.
+    await navigationStack.locationRendered();
+
+    // Check that it has restored the scroll position inside the scrollable container.
+    expect(scrollableContainer.scrollTop).to.be.closeTo(1000, 0.5);
+
+    // Check that it has restored page scroll position.
+    expect(window.pageYOffset).to.be.closeTo(500, 0.5);
 
-    // `PageScrollPositionSetter` works in an asynchronous fashion,
-    // so this delay lets it finish setting page scroll position
-    // before proceeding to next location.
+    // Return to the "/initial" page to check if it restores scroll position.
+    navigationStack.shift(-1);
+
+    // Wait for the web browser to emit a "popstate" event from `window.history.go(-1)` navigation.
     await delay(20);
+
+    // The scrollable container is only present at the "/new" or "/new-2" pages so remove it now.
+    document.body.removeChild(scrollableContainer);
+    // The scrollable container is only present at the "/new" or "/new-2" pages so untrack it now.
+    untrackScrollableContainer();
+
+    // "/initial" page rendered.
+    // Restore scroll position.
+    await navigationStack.locationRendered();
+
+    // Check that it has restored page scroll position.
+    expect(window.pageYOffset).to.be.closeTo(1000, 0.5);
   });
 });

package/test/scroll-position/ScrollPositionRestoration.test.js

@@ -133,7 +133,7 @@ describe('ScrollPositionRestoration', () => {
     it('should allow scroll suppression', (done) => {
       const app = addScrollableContainerWithAnchors(
         createApp({
-          shouldUpdatePageScrollPositionForLocation: (
+          shouldSetPageScrollPositionOnLocationChange: (
             location,
             prevLocation,
           ) => {
@@ -208,7 +208,7 @@ describe('ScrollPositionRestoration', () => {
     it('should allow custom position', (done) => {
       const app = addScrollableContainerWithAnchors(
         createApp({
-          getPageScrollPositionForLocation: () => [10, 20],
+          getSavedPageScrollPositionOnLocationChange: () => [10, 20],
         }),
       );
 
@@ -236,8 +236,8 @@ describe('ScrollPositionRestoration', () => {
     // If there were no scroll events, the scroll position doesn't get saved.
     // The rationale is that when there were no scroll events, the scroll position
     // is gonna be either a default one or a custom one specified by passing a custom
-    // `getPageScrollPositionForLocation()` function. In the latter case, the custom
-    // `getPageScrollPositionForLocation()` function is responsible to return a correct scroll position
+    // `getSavedPageScrollPositionOnLocationChange()` function. In the latter case, the custom
+    // `getSavedPageScrollPositionOnLocationChange()` function is responsible to return a correct scroll position
     // every time it gets called rather than just return a correct scroll position once,
     // save it immediately and then restore it when returning to the page.
     //
@@ -247,7 +247,7 @@ describe('ScrollPositionRestoration', () => {
     //   const app = addScrollableContainerWithAnchors(
     //     createApp({
     //       // eslint-disable-next-line no-unused-vars
-    //       getPageScrollPositionForLocation(location, prevLocation) {
+    //       getSavedPageScrollPositionOnLocationChange(location, prevLocation) {
     //         // Only when navigated via `.goTo()`. Ignore `.goBack()` navigation.
     //         if (prevLocation && location.index > prevLocation.index) {
     //           return [10, 20];
@@ -290,7 +290,7 @@ describe('ScrollPositionRestoration', () => {
     it('should follow browser scroll behavior', (done) => {
       const { container, ...app } = addScrollableContainer(
         createApp({
-          shouldUpdatePageScrollPositionForLocation: () => false,
+          shouldSetPageScrollPositionOnLocationChange: () => false,
         }),
       );
 
@@ -325,7 +325,7 @@ describe('ScrollPositionRestoration', () => {
       const { container, ...app } =
         withScrollableContainerAtIndexPageWithDisabledAutomaticScrollPositionRestoration(
           createApp({
-            shouldUpdatePageScrollPositionForLocation: () => false,
+            shouldSetPageScrollPositionOnLocationChange: () => false,
           }),
         );
 
@@ -359,7 +359,7 @@ describe('ScrollPositionRestoration', () => {
     it('should save element scroll position on scroll event, i.e. before navigation is even attempted', (done) => {
       const app1 = addScrollableContainer(
         createApp({
-          shouldUpdatePageScrollPositionForLocation: () => false,
+          shouldSetPageScrollPositionOnLocationChange: () => false,
         }),
       );
 
@@ -375,7 +375,7 @@ describe('ScrollPositionRestoration', () => {
               createApp({
                 // Restore the data of the session of `app1`.
                 sessionKey: app1.getSessionKey(),
-                shouldUpdatePageScrollPositionForLocation: () => false,
+                shouldSetPageScrollPositionOnLocationChange: () => false,
               }),
             );
 

package/test/scroll-position/createApp.js

@@ -5,8 +5,8 @@ import WebBrowserSession from '../../src/session/WebBrowserSession';
 // Creates a website with `ScrollPositionRestoration`.
 export default function createApp({
   sessionKey,
-  shouldUpdatePageScrollPositionForLocation,
-  getPageScrollPositionForLocation,
+  shouldSetPageScrollPositionOnLocationChange,
+  getSavedPageScrollPositionOnLocationChange,
 } = {}) {
   let currentLocation = null;
 
@@ -65,9 +65,10 @@ export default function createApp({
     }
     navigationStack = new NavigationStack(session);
     scrollPositionRestoration = new ScrollPositionRestoration(session, {
-      _shouldUpdatePageScrollPositionForLocation:
-        shouldUpdatePageScrollPositionForLocation,
-      _getPageScrollPositionForLocation: getPageScrollPositionForLocation,
+      _shouldSetPageScrollPositionOnLocationChange:
+        shouldSetPageScrollPositionOnLocationChange,
+      _getSavedPageScrollPositionOnLocationChange:
+        getSavedPageScrollPositionOnLocationChange,
     });
 
     unlisten = navigationStack.subscribe(onLocationDidChange);
@@ -92,10 +93,10 @@ export default function createApp({
   // Registers a scrollable container on a page.
   function registerScrollableContainer(key, element, options) {
     return scrollPositionRestoration.addScrollableContainer(key, element, {
-      _shouldUpdateScrollPositionForLocation:
-        options && options.shouldUpdateScrollPositionForLocation,
-      _getScrollPositionForLocation:
-        options && options.getScrollPositionForLocation,
+      _shouldSetScrollPositionOnLocationChange:
+        options && options.shouldSetScrollPositionOnLocationChange,
+      _getSavedScrollPositionOnLocationChange:
+        options && options.getSavedScrollPositionOnLocationChange,
     });
   }
 

package/test/scroll-position/withScrollableContainerAtIndexPageWithDisabledAutomaticScrollPositionRestoration.js

@@ -37,7 +37,7 @@ export default function withScrollableContainerAtIndexPageWithDisabledAutomaticS
           'container',
           container,
           {
-            shouldUpdateScrollPositionForLocation:
+            shouldSetScrollPositionOnLocationChange:
               shouldUpdateScrollableContainerScrollPositionForLocation,
           },
         );

package/types/scroll-position/index.d.ts

@@ -15,18 +15,18 @@ export class ScrollPositionRestoration<
 
     // `_options` are currently only used in tests.
     _options?: {
-      // `_options._shouldUpdatePageScrollPositionForLocation`
+      // `_options._shouldSetPageScrollPositionOnLocationChange`
       // isn't used in real life and is not part of the public API.
       // It's only used in tests.
-      _shouldUpdatePageScrollPositionForLocation?: (
+      _shouldSetPageScrollPositionOnLocationChange?: (
         location: Location,
         prevLocation: Location | undefined,
       ) => boolean;
 
-      // `_options._getPageScrollPositionForLocation`
+      // `_options._getSavedPageScrollPositionOnLocationChange`
       // isn't used in real life and is not part of the public API.
       // It's only used in tests.
-      _getPageScrollPositionForLocation?: (
+      _getSavedPageScrollPositionOnLocationChange?: (
         location: Location,
         prevLocation: Location | undefined,
       ) => [number, number] | undefined;
@@ -47,18 +47,18 @@ export class ScrollPositionRestoration<
 
     // `_options` are currently only used in tests.
     _options?: {
-      // `_options._shouldUpdateScrollPositionForLocation`
+      // `_options._shouldSetScrollPositionOnLocationChange`
       // isn't used in real life and is not part of the public API.
       // It's only used in tests.
-      _shouldUpdateScrollPositionForLocation?: (
+      _shouldSetScrollPositionOnLocationChange?: (
         location: Location,
         prevLocation: Location | undefined,
       ) => boolean;
 
-      // `_options._getScrollPositionForLocation`
+      // `_options._getSavedScrollPositionOnLocationChange`
       // isn't used in real life and is not part of the public API.
       // It's only used in tests.
-      _getScrollPositionForLocation?: (
+      _getSavedScrollPositionOnLocationChange?: (
         location: Location,
         prevLocation: Location | undefined,
       ) => [number, number] | undefined;