Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: remove the invalid context and location arguments from being shown as available in the loaderDeps #2091

Merged
merged 1 commit into from
Aug 6, 2024
Merged

docs: remove the invalid context and location arguments from being shown as available in the loaderDeps #2091

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 2 additions & 7 deletions docs/framework/react/api/router/RouteOptionsType.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,18 +143,13 @@ type loader = (
- Type:

```tsx
type loaderDeps = (opts: {
search: TFullSearchSchema
location: ParsedLocation
context: TAllContext
}) => Record<string, any>
type loaderDeps = (opts: { search: TFullSearchSchema }) => Record<string, any>
```

- Optional
- [`ParsedLocation`](./ParsedLocationType.md)
- A function that will be called before this route is matched to provide additional unique identification to the route match and serve as a dependency tracker for when the match should be reloaded. It should return any serializable value that can uniquely identify the route match from navigation to navigation.
- By default, path params are already used to uniquely identify a route match, so it's unnecessary to return these here.
- If your route match relies on search params or context values for unique identification, it's required that you return them here so they can be made available in the `loader`'s `deps` argument.
- If your route match relies on search params for unique identification, it's required that you return them here so they can be made available in the `loader`'s `deps` argument.

### `staleTime` property

Expand Down