fix: update type annotations in beforeUpload function

[cc-hearts]

Fix type errors in example.

Summary by CodeRabbit

• 文档
  • 优化了示例中 beforeUpload 函数的类型声明，使参数类型更加明确。

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
upload	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Aug 3, 2025 4:49am

[coderabbitai]

Walkthrough

本次变更主要针对 docs/examples/beforeUpload.tsx 文件，规范了 beforeUpload 函数的类型声明，明确了参数和返回值类型，未涉及业务逻辑或控制流的修改。

Changes

Cohort / File(s)	Change Summary
类型声明规范化 docs/examples/beforeUpload.tsx	明确 beforeUpload 函数参数为 file: RcFile、fileList: RcFile[]，Promise 返回类型由 string 改为 RcFile，仅涉及类型声明，无业务逻辑变更。

Estimated code review effort

🎯 1 (琐碎) | ⏱️ ~2 分钟

Poem

兔子蹦蹦跳，类型更明了，
代码小修饰，安全又可靠。
Promise 不再迷，RcFile 回家了，
轻松审核过，继续向前跑！
🐇✨

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

✨ Finishing Touches

• 📝 Generate Docstrings

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a 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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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 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 (1)

docs/examples/beforeUpload.tsx (1)

18-27: 为 beforeUpload 明确返回类型以消除隐式推断

已将参数改成 RcFile，很好。但当前仍依赖 TypeScript 推断返回类型；为了示例更直观、也方便阅读建议显式标注：

-beforeUpload(file: RcFile, fileList: RcFile[]) {
+beforeUpload(file: RcFile, fileList: RcFile[]): Promise<RcFile> {

顺带一提，onStart 的 file 也可类型化保持一致性：

-onStart(file) {
+onStart(file: RcFile) {

这样整段示例的类型信息就完整了。

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 9c9dc95 and 98e46cd.

📒 Files selected for processing (1)

• docs/examples/beforeUpload.tsx (2 hunks)

🧰 Additional context used

🧠 Learnings (2)

📓 Common learnings

Learnt from: zombieJ
PR: react-component/upload#543
File: src/AjaxUploader.tsx:116-116
Timestamp: 2025-04-09T06:22:00.335Z
Learning: 在 react-component/upload 项目中，黏贴上传功能应该是可配置的，只有当启用此功能时才应添加 paste 事件监听器，而不是无条件添加。同时，事件监听器绑定应使用预先绑定的方法而非直接使用 .bind(this) 以避免内存泄漏。

📚 Learning: 在 react-component/upload 项目中，黏贴上传功能应该是可配置的，只有当启用此功能时才应添加 paste 事件监听器，而不是无条件添加。同时，事件监听器绑定应使用预先绑定的方法而非...

Learnt from: zombieJ
PR: react-component/upload#543
File: src/AjaxUploader.tsx:116-116
Timestamp: 2025-04-09T06:22:00.335Z
Learning: 在 react-component/upload 项目中，黏贴上传功能应该是可配置的，只有当启用此功能时才应添加 paste 事件监听器，而不是无条件添加。同时，事件监听器绑定应使用预先绑定的方法而非直接使用 .bind(this) 以避免内存泄漏。

Applied to files:

• docs/examples/beforeUpload.tsx

🧬 Code Graph Analysis (1)

docs/examples/beforeUpload.tsx (1)

src/interface.tsx (1)

• RcFile (81-83)

🔇 Additional comments (1)

docs/examples/beforeUpload.tsx (1)

3-3: 使用 import type 很好，但请确认路径别名是否在 tsconfig.json 中正确配置

import type { Action, RcFile } from '@/interface'; 能避免运行时依赖，非常赞。不过 @/interface 依赖于 paths 或 baseUrl 配置，若示例单独拷贝到其他项目可能会找不到该别名。请确认：

1. tsconfig.json 中是否已包含

   { "paths": { "@/*": ["src/*"] } }

2. 或者考虑示例里改用相对路径，降低复制门槛。

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 89.03%. Comparing base (9c9dc95) to head (98e46cd).
⚠️ Report is 1 commits behind head on master.

Additional details and impacted files

@@           Coverage Diff           @@
##           master     #646   +/-   ##
=======================================
  Coverage   89.03%   89.03%           
=======================================
  Files           6        6           
  Lines         301      301           
  Branches       82       80    -2     
=======================================
  Hits          268      268           
  Misses         33       33           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.