docs: remove the invalid context
and location
arguments from being shown as available in the loaderDeps
#2091
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
We haven't had the
context
andlocation
arguments present asloaderDeps
options, so this corrects this error in Router's documentation.The reason we don't have
location
as an argument ofloaderDeps
is quite simple. If thelocation
changes, the loader would anyways have to be refired (or retrieved from a cache using something like Query). The scenario in which this wouldn't be the case, is if you wanted to prevent this from happening when search params change. This is why onlysearch
is provided as its own argument.The reason we don't have
context
as an argument ofloaderDeps
is because, when the root context has been changed, the user is expected to callrouter.invalidate()
. Thisinvalidate
call discards all cached data and re-evaluates the entire route-tree. As such, havingcontext
as an argument inloaderDeps
, makes no sense, since it wouldn't actually contribute anything towards the actualloaderDeps
functionality.