Skip to content

Commit

Permalink
Section about deprecated onDemand and onAbort callback arguments (#2330)
Browse files Browse the repository at this point in the history
* Added deprecated onDemand and onAbort callback arguments to migration guide

The  onDemand and onAbort  callbacks for router.push and .replace were deprecated in v4. I added a section to the migration guide explaining that users should replace them with the thenable Promise the methods return.

* Apply suggestions from code review

* Update packages/docs/guide/migration/index.md [skip ci]

---------

Co-authored-by: Eduardo San Martin Morote <[email protected]>
  • Loading branch information
DangerousDetlef and posva authored Aug 6, 2024
1 parent 7d1db18 commit 9f95fb7
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions packages/docs/guide/migration/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -443,6 +443,12 @@ Given any [normalized route location](/api/#RouteLocationNormalized):

**Reason**: This allows to easily copy existing properties of a location when calling `router.push()` and `router.resolve()`, and make the resulting route location consistent across browsers. `router.push()` is now idempotent, meaning that calling `router.push(route.fullPath)`, `router.push({ hash: route.hash })`, `router.push({ query: route.query })`, and `router.push({ params: route.params })` will not create extra encoding.

### `$router.push()` and `$router.replace()` - `onComplete` and `onAbort` callbacks

Previously, `$router.push()` and `$router.replace()` accepted two callbacks, `onComplete` and `onAbort`, as second and third arguments. They were called after a navigation based on the result. With the introduction of a Promise based API, these callbacks are redundant and have been removed. See [Navigation Failures](/guide/advanced/navigation-failures.md) for more information on how to detect successful and failed navigations.

**Reason**: Reduce library size by adapting to established JS standards (Promises).

### TypeScript changes

To make typings more consistent and expressive, some types have been renamed:
Expand Down

0 comments on commit 9f95fb7

Please sign in to comment.