docs: Add documentation for updating multiple parameters at once #107
Conversation
|
WalkthroughThe changes to the Changes
Assessment against linked issues
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
✅ Deploy Preview for sveltekit-search-params ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- README.md (2 hunks)
Additional context used
LanguageTool
README.md
[uncategorized] ~135-~135: Possible missing comma found.
Context: ...rning** > > You can't rungotoon the server so if the page is server side rendered ...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~220-~220: Possible missing comma found.
Context: ...update multiple different parameters at once you will want to use theupdate()met...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~245-~245: Possible missing comma found.
Context: ...ndividually assign each property on the store you may get `sveltekit 'client.js Uncau...(AI_HYDRA_LEO_MISSING_COMMA)
Markdownlint
README.md
224-224: Column: 1
Hard tabs(MD010, no-hard-tabs)
226-226: Column: 1
Hard tabs(MD010, no-hard-tabs)
228-228: Column: 1
Hard tabs(MD010, no-hard-tabs)
229-229: Column: 1
Hard tabs(MD010, no-hard-tabs)
230-230: Column: 1
Hard tabs(MD010, no-hard-tabs)
231-231: Column: 1
Hard tabs(MD010, no-hard-tabs)
232-232: Column: 1
Hard tabs(MD010, no-hard-tabs)
233-233: Column: 1
Hard tabs(MD010, no-hard-tabs)
234-234: Column: 1
Hard tabs(MD010, no-hard-tabs)
235-235: Column: 1
Hard tabs(MD010, no-hard-tabs)
236-236: Column: 1
Hard tabs(MD010, no-hard-tabs)
237-237: Column: 1
Hard tabs(MD010, no-hard-tabs)
Additional comments not posted (3)
README.md (3)
135-135: Typographical correction approved.The correction from "relay" to "rely" improves clarity.
Tools
LanguageTool
[uncategorized] ~135-~135: Possible missing comma found.
Context: ...rning** > > You can't rungotoon the server so if the page is server side rendered ...(AI_HYDRA_LEO_MISSING_COMMA)
218-241: New section on updating multiple parameters approved with minor improvements.The new section provides valuable guidance on using the
update()method to update multiple parameters simultaneously. However, there are minor improvements needed:
Add missing commas:
- Line 220: Add a comma after "at once".
- Line 245: Add a comma after "store".
Replace hard tabs with spaces:
- Lines 224, 226, 228-237: Replace hard tabs with spaces for consistency.
Apply this diff to address the issues:
-When using `queryParameters` if you need to update multiple different parameters at once you will want to use the `update()` method to update the store to prevent multiple calls of `goto()`. +When using `queryParameters`, if you need to update multiple different parameters at once, you will want to use the `update()` method to update the store to prevent multiple calls of `goto()`. ```diff -If you don't use the update and instead individually assign each property on the store you may get `sveltekit 'client.js Uncaught (in promise) Error: navigation aborted'` errors. +If you don't use the update, and instead individually assign each property on the store, you may get `sveltekit 'client.js Uncaught (in promise) Error: navigation aborted'` errors.-<script lang="ts"> - import { queryParameters } from 'sveltekit-search-params'; - - const store = queryParameters(); - - const update = (value) => { - store.update((v) => { - return { - ...v, - from: value.from, - to: value.to, - period: value.period, - }; - }); - }; -</script> +<script lang="ts"> + import { queryParameters } from 'sveltekit-search-params'; + + const store = queryParameters(); + + const update = (value) => { + store.update((v) => { + return { + ...v, + from: value.from, + to: value.to, + period: value.period, + }; + }); + }; +</script>Tools
LanguageTool
[uncategorized] ~220-~220: Possible missing comma found.
Context: ...update multiple different parameters at once you will want to use theupdate()met...(AI_HYDRA_LEO_MISSING_COMMA)
Markdownlint
224-224: Column: 1
Hard tabs(MD010, no-hard-tabs)
226-226: Column: 1
Hard tabs(MD010, no-hard-tabs)
228-228: Column: 1
Hard tabs(MD010, no-hard-tabs)
229-229: Column: 1
Hard tabs(MD010, no-hard-tabs)
230-230: Column: 1
Hard tabs(MD010, no-hard-tabs)
231-231: Column: 1
Hard tabs(MD010, no-hard-tabs)
232-232: Column: 1
Hard tabs(MD010, no-hard-tabs)
233-233: Column: 1
Hard tabs(MD010, no-hard-tabs)
234-234: Column: 1
Hard tabs(MD010, no-hard-tabs)
235-235: Column: 1
Hard tabs(MD010, no-hard-tabs)
236-236: Column: 1
Hard tabs(MD010, no-hard-tabs)
237-237: Column: 1
Hard tabs(MD010, no-hard-tabs)
243-245: Warning about potential errors approved with minor improvement.The warning is clear and helpful. However, add a comma after "store" to improve readability.
Apply this diff to address the issue:
-If you don't use the update and instead individually assign each property on the store you may get `sveltekit 'client.js Uncaught (in promise) Error: navigation aborted'` errors. +If you don't use the update, and instead individually assign each property on the store, you may get `sveltekit 'client.js Uncaught (in promise) Error: navigation aborted'` errors.Tools
LanguageTool
[uncategorized] ~245-~245: Possible missing comma found.
Context: ...ndividually assign each property on the store you may get `sveltekit 'client.js Uncau...(AI_HYDRA_LEO_MISSING_COMMA)
Adds guidance in the README on how to handle updating multiple parameters at once.
(Removes all the unnecessary changes)
Summary by CodeRabbit