refactor(router): in onNavigateTo args rename cancelled to `navig…

…ationWasCancelled`
MrWolfZ · Jan 2, 2021 · da4359f · da4359f
1 parent cd249ae
commit da4359f
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 13 deletions.
diff --git a/packages/router/api.md b/packages/router/api.md
@@ -34,9 +34,9 @@ export type OnNavigateTo<TParameters = NavigationParameters> = (parameters: Immu
 
 // @public
 export interface OnNavigateToExtras {
- readonly cancelled: Promise<typeof NAVIGATION_CANCELLED>;
  readonly cancelNavigation: typeof NAVIGATION_CANCELLED;
  readonly navigationIsToChildRoute: boolean;
+ readonly navigationWasCancelled: Promise<typeof NAVIGATION_CANCELLED>;
 }
 
 // @public

diff --git a/packages/router/e2e.spec.ts b/packages/router/e2e.spec.ts
@@ -53,8 +53,8 @@ describe(`@simplux/router`, () => {
 
  let cancelledNavigation = new Promise<typeof NAVIGATION_CANCELLED>(() => {})
  const cancelledNavRoute = router.addRoute('asyncNever', {
- onNavigateTo: (_, { cancelled }) => {
- cancelledNavigation = cancelled
+ onNavigateTo: (_, { navigationWasCancelled }) => {
+ cancelledNavigation = navigationWasCancelled
  return new Promise<void>(() => {})
  },
  })
@@ -63,7 +63,7 @@ describe(`@simplux/router`, () => {
  cancelledNavRoute.onNavigateTo(
  {},
  {
- cancelled: undefined!,
+ navigationWasCancelled: undefined!,
  cancelNavigation: NAVIGATION_CANCELLED,
  navigationIsToChildRoute: false,
  },
@@ -78,7 +78,7 @@ describe(`@simplux/router`, () => {
  await routeThatCancelsNav.onNavigateTo(
  {},
  {
- cancelled: undefined!,
+ navigationWasCancelled: undefined!,
  cancelNavigation: NAVIGATION_CANCELLED,
  navigationIsToChildRoute: false,
  },

diff --git a/packages/router/src/module.spec.ts b/packages/router/src/module.spec.ts
@@ -854,8 +854,8 @@ describe(`module`, () => {
 
  const interceptor = jest
  .fn<Promise<void>, [any, OnNavigateToExtras]>()
- .mockImplementationOnce((_, { cancelled }) => {
- cancellationPromise = cancelled
+ .mockImplementationOnce((_, { navigationWasCancelled }) => {
+ cancellationPromise = navigationWasCancelled
  return new Promise<void>(() => {})
  })
 
@@ -1320,8 +1320,8 @@ describe(`module`, () => {
 
  const childInterceptor = jest
  .fn<Promise<void>, [any, OnNavigateToExtras]>()
- .mockImplementationOnce((_, { cancelled }) => {
- childCancellationPromise = cancelled
+ .mockImplementationOnce((_, { navigationWasCancelled }) => {
+ childCancellationPromise = navigationWasCancelled
  return new Promise<void>(() => {})
  })
 
@@ -1363,8 +1363,8 @@ describe(`module`, () => {
 
  const parentInterceptor = jest
  .fn<Promise<void>, [any, OnNavigateToExtras]>()
- .mockImplementationOnce((_, { cancelled }) => {
- parentCancellationPromise = cancelled
+ .mockImplementationOnce((_, { navigationWasCancelled }) => {
+ parentCancellationPromise = navigationWasCancelled
  return new Promise<void>(() => {})
  })
 

diff --git a/packages/router/src/module.ts b/packages/router/src/module.ts
@@ -62,7 +62,7 @@ export interface OnNavigateToExtras {
  * (e.g. because a new navigation has started while this
  * function was running).
  */
- readonly cancelled: Promise<typeof NAVIGATION_CANCELLED>
+ readonly navigationWasCancelled: Promise<typeof NAVIGATION_CANCELLED>
 
  /**
  * This object can be returned to cancel the navigation.
@@ -291,7 +291,7 @@ const effects = createEffects({
 
  if (interceptor) {
  const onNavigateToExtras: OnNavigateToExtras = {
- cancelled: cancellationPromise,
+ navigationWasCancelled: cancellationPromise,
  cancelNavigation: NAVIGATION_CANCELLED,
  navigationIsToChildRoute: routeId !== targetRouteId,
  }