docs(router): align RouteMatch API reference with the current public contract
维护者通常 1 天内回复
评估
- 难度
- 2/5
- 预计耗时
- 1-3 小时
- 新手友好度
- 78/100
- Issue 类型
- 文档
- 描述清晰度
- 描述清楚
- 活跃度
- 冷清
- 技术栈
- typescript
调研方向
从 docs/router/api/router/RouteMatchType.md 开始，并将其与 packages/router-core/src/Matches.ts 进行对比，以 issue 中描述的公共契约为指导。移除过时字段和内部字段，添加指定的公共字段及 cause 值，并检查完整页面的准确性。当参考内容与预期的公共 RouteMatch API 一致，且不包含仅用于生命周期的状态时，即表示完成。
由索引模型根据 Issue 内容生成。
描述
Goal
Bring the RouteMatch API reference in line with the current public contract.
Scope
- Remove obsolete
showPendingandfetchedAtentries fromdocs/router/api/router/RouteMatchType.md. - Add
fullPathusing its route-specific type,Route['fullPath']. - Add
indexand explain its ordering within the matched route array. - Update
causeto include'preload'. - Keep internal and lifecycle-specific match state out of the reference, including
displayPendingPromise,fetchCount,preload,invalid,headers, andglobalNotFound. - Review the complete page against
packages/router-core/src/Matches.tsso the reference describes the intentional public API.
Related Work
This continues the RouteMatch reference update started in #4894
- 主要语言
- TypeScript
- 星标
- 15.2k
- 派生
- 1.9k
- 平均合并
- 1 天 13 小时
- 30 天内合并 PR
- 76
环境准备
在浏览器里用你自己的 GitHub 账号启动这个项目的开发容器。
- 没有 Dockerfile 或 Docker Compose 文件
- 有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
TanStack/router 的其他 Issue
-
router.startViewTransition leaves the ready/finished promises unhandled, so a skipped transition throws an unhandled AbortError可能已有人在做 @unjica 于 3 天前认领。 未关闭
难度 2/5 1-3 小时 新手友好度 74/100
TanStack/router#8776 · 3 条评论 · 1 个 reaction ·
维护者通常 1 天内回复
-
Router devtools crash when search params contain a BigInt (JSON.stringify in history tracking)可能已有人在做 @A-Raphie 于 7 天前认领。 未关闭
难度 2/5 1-3 小时 新手友好度 76/100
维护者通常 1 天内回复
-
docs: `createLink` has no API reference page; 3 how-to guides link to a missing `#createlink` anchor可能已有人在做 @A-Raphie 于 7 天前认领。 未关闭
难度 2/5 1-3 小时 新手友好度 88/100
维护者通常 1 天内回复
-
Inline scripts are duplicated after hydration when the CSP nonce is sent in a header可能已有人在做 @gabriel-le 于 28 天前认领。 未关闭
难度 1/5 1 小时以内 新手友好度 90/100
维护者通常 1 天内回复
-
start-plugin-core: sitemap lastmod and pages.json lastBuilt are stamped with the build's wall clock (no SOURCE_DATE_EPOCH support)可能已有人在做 @treadnot 于 29 天前认领。 未关闭
难度 2/5 1-3 小时 新手友好度 84/100
维护者通常 1 天内回复
相似的 Issue
-
难度 1/5 1 小时以内 新手友好度 82/100
维护者通常 1 天内回复
-
bug
难度 2/5 1-3 小时 新手友好度 82/100
juice-shop/juice-shop#3706 ·
维护者通常 1 天内回复
-
sbx up from a subfolder silently pushes the whole work tree可能已有人在做 @pdettori 今天认领。 未关闭enhancement
难度 2/5 1-3 小时 新手友好度 76/100
维护者通常 1 天内回复
-
bug
难度 2/5 1-3 小时 新手友好度 68/100
outline/outline#14348 · 1 条评论 ·
维护者通常 1 天内回复
-
bug needs-triage
难度 2/5 1-3 小时 新手友好度 68/100
维护者通常 1 天内回复