docs: update the fetch clear function description #32287

xjccc · 2025-06-04T07:25:35Z

🔗 Linked issue

📚 Description

bolt-new-by-stackblitz · 2025-06-04T07:25:38Z

Run & review this pull request in StackBlitz Codeflow.

coderabbitai · 2025-06-04T07:27:57Z

Walkthrough

The documentation for the clear function in the useFetch and useAsyncData composables was revised across multiple files. The updates clarify that when invoked, clear sets data to the value returned by options.default() if provided, or to undefined otherwise. Additionally, error is now set to undefined rather than null, and status is set to idle (without quotation marks). The documentation also reaffirms that any pending requests are cancelled. No changes were made to the actual code or exported/public entity declarations.

✨ Finishing Touches

🧪 Generate Unit Tests

Create PR with Unit Tests
Post Copyable Unit Tests in Comment

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.

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Explain this complex logic.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai explain this code block.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and explain its main purpose.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Support

Need 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)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai auto-generate unit tests to generate unit tests for this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

coderabbitai

Actionable comments posted: 0

🧹 Nitpick comments (3)

docs/3.api/2.composables/use-async-data.md (1)

157-157: Refine phrasing for clarity

Consider replacing “if you set it” with “if provided” to make the description more concise and consistent with other docs.

docs/1.getting-started/10.data-fetching.md (1)

233-233: Refine phrasing for clarity

Consider replacing “if you set it” with “if provided” to improve readability and align with related documentation.

🧰 Tools

🪛 LanguageTool

[uncategorized] ~233-~233: Loose punctuation mark.
Context: ...ned by the handler function. - clear: a function that can be used to set `dat...

(UNLIKELY_OPENING_PUNCTUATION)

docs/3.api/2.composables/use-fetch.md (1)

162-162: Refine phrasing for clarity

Consider replacing “if you set it” with “if provided” for a cleaner, more consistent description across the docs.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 42114f4 and 2d51ce0.

📒 Files selected for processing (3)

docs/1.getting-started/10.data-fetching.md (1 hunks)
docs/3.api/2.composables/use-async-data.md (1 hunks)
docs/3.api/2.composables/use-fetch.md (1 hunks)

🧰 Additional context used

🪛 LanguageTool

docs/1.getting-started/10.data-fetching.md

[uncategorized] ~233-~233: Loose punctuation mark.
Context: ...ned by the handler function. - clear: a function that can be used to set `dat...

(UNLIKELY_OPENING_PUNCTUATION)

⏰ Context from checks skipped due to timeout of 90000ms (1)

GitHub Check: lint-docs

coderabbitai

Actionable comments posted: 0

🧹 Nitpick comments (1)

docs/1.getting-started/10.data-fetching.md (1)
233-236: Use the same quoting style for status as elsewhere in the doc

A few lines below (status bullet, line 235) the valid states are documented as "idle", "pending" … —all wrapped in back-ticks and double quotes.
Here, the new sentence uses idle without quotes. For consistency:
- set `status` to `idle`,
+ set `status` to `"idle"`,
This helps readers recognise that the value is a string literal just like the others.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 53f601a and fe336a8.

📒 Files selected for processing (3)

docs/1.getting-started/10.data-fetching.md (1 hunks)
docs/3.api/2.composables/use-async-data.md (1 hunks)
docs/3.api/2.composables/use-fetch.md (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (2)

docs/3.api/2.composables/use-async-data.md
docs/3.api/2.composables/use-fetch.md

🧰 Additional context used

🪛 LanguageTool

docs/1.getting-started/10.data-fetching.md

[uncategorized] ~233-~233: Loose punctuation mark.
Context: ...ned by the handler function. - clear: a function that can be used to set `dat...

(UNLIKELY_OPENING_PUNCTUATION)

⏰ Context from checks skipped due to timeout of 90000ms (1)

GitHub Check: lint-docs

docs: update the fetch clear function description

2d51ce0

xjccc requested a review from danielroe as a code owner June 4, 2025 07:25

github-actions bot added 3.x documentation labels Jun 4, 2025

coderabbitai bot reviewed Jun 4, 2025

View reviewed changes

xjccc and others added 3 commits June 4, 2025 15:55

docs: nitpick

53f601a

Merge remote-tracking branch 'origin/main' into docs/fetch-clear

d80317c

docs: reverse condition

fe336a8

danielroe approved these changes Jun 24, 2025

View reviewed changes

coderabbitai bot reviewed Jun 24, 2025

View reviewed changes

danielroe merged commit 3bbbaa6 into nuxt:main Jun 24, 2025
7 of 8 checks passed

github-actions bot mentioned this pull request Jun 24, 2025

v4.0.0 #27716

Draft

xjccc deleted the docs/fetch-clear branch June 24, 2025 08:44

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

docs: update the fetch clear function description #32287

docs: update the fetch clear function description #32287

Uh oh!

xjccc commented Jun 4, 2025

Uh oh!

bolt-new-by-stackblitz bot commented Jun 4, 2025

Uh oh!

coderabbitai bot commented Jun 4, 2025 •

edited

Loading

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

Uh oh!

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Uh oh!

docs: update the fetch clear function description #32287

docs: update the fetch clear function description #32287

Uh oh!

Conversation

xjccc commented Jun 4, 2025

🔗 Linked issue

📚 Description

Uh oh!

bolt-new-by-stackblitz bot commented Jun 4, 2025

Uh oh!

coderabbitai bot commented Jun 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

coderabbitai bot commented Jun 4, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)