docs: add reference to useNuxtData under useFetch
#32589
Conversation
|
|
WalkthroughNotes were added to the documentation for the ✨ Finishing Touches🧪 Generate unit tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. 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 (
|
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
docs/3.api/2.composables/use-fetch.md (1)
85-86: Trim superfluous trailing spaces before the next admonitionThere are two consecutive spaces after the closing parenthesis on line 85 (just before the blank line). They are unnecessary and trigger the “Loose punctuation mark” warning from LanguageTool. Removing them will silence the linter and avoid unintended soft-breaks in the rendered Markdown.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/3.api/2.composables/use-fetch.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/3.api/2.composables/use-fetch.md
[uncategorized] ~86-~86: Loose punctuation mark.
Context: ...(/docs/api/composables/use-nuxt-data). ::warning useFetch is a reserved functi...
(UNLIKELY_OPENING_PUNCTUATION)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: lint-docs
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
docs/3.api/2.composables/use-fetch.md (1)
85-87: Consider adding a concise code snippet for quick recallThe wording is clear, but an ultra-short example makes it immediately obvious how to retrieve the data and reminds readers about the key that must match.
Example (feel free to tweak names):::tip -Keyed state created using `useFetch` can be retrieved across your Nuxt application using [`useNuxtData`](/docs/api/composables/use-nuxt-data). +Keyed state created using `useFetch` can be retrieved anywhere with [`useNuxtData`](/docs/api/composables/use-nuxt-data): + +```ts +// reuse the same key that was generated or explicitly passed to useFetch +const { data: posts } = useNuxtData('posts') +``` +Ensure the key passed to `useNuxtData` is identical to the one generated (or provided via the `key` option) in the original `useFetch` call. ::Adds only a few lines but gives readers a copy-pasteable pattern.
docs/3.api/2.composables/use-async-data.md (1)
145-147: Mirror theuseFetchimprovement for parityFor consistency with the previous page (and to save readers a jump), you can embed the same micro-snippet here:
::tip -Keyed state created using `useAsyncData` can be retrieved across your Nuxt application using [`useNuxtData`](/docs/api/composables/use-nuxt-data). +Keyed state created using `useAsyncData` can be retrieved anywhere with [`useNuxtData`](/docs/api/composables/use-nuxt-data): + +```ts +const { data: users } = useNuxtData('users') +``` +Use the exact key that `useAsyncData` generated or that you passed explicitly. ::Keeps both composable docs symmetrical and gives an instant, runnable example.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
docs/3.api/2.composables/use-async-data.md(1 hunks)docs/3.api/2.composables/use-fetch.md(1 hunks)
🧰 Additional context used
🧠 Learnings (3)
📓 Common learnings
Learnt from: CR
PR: nuxt/nuxt#0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-06-30T13:48:28.134Z
Learning: Applies to **/*.{ts,tsx,vue} : Add comments only to explain complex logic or non-obvious implementations
Learnt from: huang-julien
PR: nuxt/nuxt#29366
File: packages/nuxt/src/app/components/nuxt-root.vue:16-19
Timestamp: 2024-12-12T12:36:34.871Z
Learning: In `packages/nuxt/src/app/components/nuxt-root.vue`, when optimizing bundle size by conditionally importing components based on route metadata, prefer using inline conditional imports like:
```js
const IsolatedPage = route?.meta?.isolate ? defineAsyncComponent(() => import('#build/isolated-page.mjs')) : null
```
instead of wrapping the import in a computed property or importing the component unconditionally.
docs/3.api/2.composables/use-async-data.md (1)
Learnt from: huang-julien
PR: nuxt/nuxt#29366
File: packages/nuxt/src/app/components/nuxt-root.vue:16-19
Timestamp: 2024-12-12T12:36:34.871Z
Learning: In `packages/nuxt/src/app/components/nuxt-root.vue`, when optimizing bundle size by conditionally importing components based on route metadata, prefer using inline conditional imports like:
```js
const IsolatedPage = route?.meta?.isolate ? defineAsyncComponent(() => import('#build/isolated-page.mjs')) : null
```
instead of wrapping the import in a computed property or importing the component unconditionally.
docs/3.api/2.composables/use-fetch.md (1)
Learnt from: huang-julien
PR: nuxt/nuxt#29366
File: packages/nuxt/src/app/components/nuxt-root.vue:16-19
Timestamp: 2024-12-12T12:36:34.871Z
Learning: In `packages/nuxt/src/app/components/nuxt-root.vue`, when optimizing bundle size by conditionally importing components based on route metadata, prefer using inline conditional imports like:
```js
const IsolatedPage = route?.meta?.isolate ? defineAsyncComponent(() => import('#build/isolated-page.mjs')) : null
```
instead of wrapping the import in a computed property or importing the component unconditionally.
🪛 LanguageTool
docs/3.api/2.composables/use-async-data.md
[uncategorized] ~146-~146: Loose punctuation mark.
Context: ...](/docs/api/composables/use-nuxt-data). :: ## Return Values - data: the resul...
(UNLIKELY_OPENING_PUNCTUATION)
docs/3.api/2.composables/use-fetch.md
[uncategorized] ~86-~86: Loose punctuation mark.
Context: ...](/docs/api/composables/use-nuxt-data). :: ::warning useFetch is a reserved fu...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~88-~88: Loose punctuation mark.
Context: ...ocs/api/composables/use-nuxt-data). :: ::warning useFetch is a reserved functi...
(UNLIKELY_OPENING_PUNCTUATION)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: lint-docs
📚 Description
Add reference and link to the
useNuxtDatadocumentation page under Reactive Keys and Shared State in order to provide greater clarity on how state is retrieved when usinguseFetch.