Skip to content

Commit

Permalink
Update asPath to mention basePath/locale stripping (#18807)
Browse files Browse the repository at this point in the history
Tweak `asPath` docs to mention `basePath` and `locale` will not be included in the value. 

Closes: #18782
  • Loading branch information
ijjk committed Nov 4, 2020
1 parent 5e9d1aa commit cdaf837
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/api-reference/next/router.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ The following is the definition of the `router` object returned by both [`useRou

- `pathname`: `String` - Current route. That is the path of the page in `/pages`
- `query`: `Object` - The query string parsed to an object. It will be an empty object during prerendering if the page doesn't have [data fetching requirements](/docs/basic-features/data-fetching.md). Defaults to `{}`
- `asPath`: `String` - Actual path (including the query) shown in the browser.
- `asPath`: `String` - The path (including the query) shown in the browser without the configured `basePath` or `locale`.
- `isFallback`: `boolean` - Whether the current page is in [fallback mode](/docs/basic-features/data-fetching#fallback-pages).
- `basePath`: `String` - The active [basePath](/docs/api-reference/next.config.js/basepath) (if enabled).
- `locale`: `String` - The active locale (if enabled).
Expand Down

0 comments on commit cdaf837

Please sign in to comment.