From: Eduardo San Martin Morote Date: Mon, 14 Jun 2021 14:06:09 +0000 (+0200) Subject: docs: note about params type X-Git-Tag: v4.0.9~8 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=0c912920e39c361210210f5e16ebf8096d2be1fe;p=thirdparty%2Fvuejs%2Frouter.git docs: note about params type Close #873 --- diff --git a/docs/guide/essentials/navigation.md b/docs/guide/essentials/navigation.md index ee2cc6c3..31eefb14 100644 --- a/docs/guide/essentials/navigation.md +++ b/docs/guide/essentials/navigation.md @@ -51,6 +51,8 @@ router.push({ name: 'user', params: { username } }) // -> /user/eduardo router.push({ path: '/user', params: { username } }) // -> /user ``` +When specifying `params`, make sure to either provide a `string` or `number` (or an array of these for [repeatable params](./oute-matching-syntax.md#repeatable-params)). **Any other type (like `undefined`, `false`, etc) will be automatically stringified**. For [optional params](./route-matching-syntax.md#repeatable-params), you can provide an empty string (`""`) as the value to skip it. + Since the prop `to` accepts the same kind of object as `router.push`, the exact same rules apply to both of them. `router.push` and all the other navigation methods return a _Promise_ that allows us to wait til the navigation is finished and to know if it succeeded or failed. We will talk more about that in [Navigation Handling](../advanced/navigation-failures.md).