Skip to content

docs: fill durably-react API reference gaps#161

Merged
coji merged 1 commit into
mainfrom
docs/react-api-reference-gaps
Mar 27, 2026
Merged

docs: fill durably-react API reference gaps#161
coji merged 1 commit into
mainfrom
docs/react-api-reference-gaps

Conversation

@coji
Copy link
Copy Markdown
Owner

@coji coji commented Mar 27, 2026

Summary

Fill documentation gaps found during the #141/#156 review cycle. Only items independent of the React 19 redesign (#160).

  • Add TypedClientRun, TypedRun, DurablyEvent type definitions to types.md
  • Add createDurablyHandler options table (sseThrottleMs, onRequest, auth) to fullstack.md
  • Add useJobRun return type table to spa.md (including isCancelled)
  • Clarify filter semantics in both fullstack.md and spa.md: status array = any match, labels = all must match
  • Add SPA useRuns return type summary to llms.md
  • Regenerate llms.txt

Test plan

  • pnpm validate 28/28 pass
  • No code changes, docs only

Closes #157

🤖 Generated with Claude Code

Summary by CodeRabbit

リリースノート

  • ドキュメンテーション

    • useRuns フックのパラメータ仕様とフィルター動作を明確化
    • useJobRun フックの戻り値フィールド(ログ、進捗、ステータスフラグ)を追加文書化
    • createDurablyHandler の設定オプション(SSEスロットリング、ライフサイクルフック)を文書化
  • 新機能

    • 型安全性を向上させるための新しい TypeScript 型を追加

- Add TypedClientRun, TypedRun, DurablyEvent to types.md
- Add createDurablyHandler options table (sseThrottleMs, onRequest, auth)
- Add useJobRun return type table to spa.md (including isCancelled)
- Clarify filter semantics: status array = any match, labels = all must match
- Add SPA useRuns return type summary to llms.md
- Regenerate llms.txt

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Mar 27, 2026

Caution

Review failed

Pull request was closed or merged during review

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: f9e8b88e-a8b8-417a-92dc-fcc68209f8d5

📥 Commits

Reviewing files that changed from the base of the PR and between a8de66c and dd28b2b.

📒 Files selected for processing (5)
  • packages/durably-react/docs/llms.md
  • website/api/durably-react/fullstack.md
  • website/api/durably-react/spa.md
  • website/api/durably-react/types.md
  • website/public/llms.txt

📝 Walkthrough

概要

主にドキュメンテーションの追加と型定義の拡張で構成されています。useRunsのリターンオブジェクト形状、フィルタリングセマンティクス、createDurablyHandlerオプション、useJobRunリターン型、および新しい汎用型(TypedClientRunTypedRunDurablyEvent)を文書化しました。

変更内容

Cohort / File(s) Summary
useRuns戻り値とフィルタセマンティクスのドキュメント
packages/durably-react/docs/llms.md, website/public/llms.txt
useRunsの戻り値として{ runs, page, hasMore, isLoading, nextPage, prevPage, goToPage, refresh }を明示し、ページネーションが0インデックスであること、statusフィルタは複数値のいずれかとマッチし、labelsフィルタはすべてのキー/バリューペアのマッチを要求することを明確化しました。
サーバー統合とAPIドキュメント更新
website/api/durably-react/fullstack.md
createDurablyHandlerの使用法を更新し、オプションオブジェクト(sseThrottleMsonRequestを含む)を追加。フィルタセマンティクスも合わせて文書化しました。
SPAモードのドキュメント拡張
website/api/durably-react/spa.md
useJobRunのリターン型セクションを追加し、logsprogress、およびブール状態フラグ(isLeasedisPendingisCompletedisFailedisCancelled)を文書化。useRunsフィルタセマンティクスも明確化しました。
汎用型定義の追加
website/api/durably-react/types.md
TypedClientRun<TInput, TOutput>TypedRun<TInput, TOutput>、およびDurablyEvent(SSEイベントペイロード形状の判別共用体)を新規エクスポート型として追加しました。

関連する可能性のある課題

  • 課題 #157TypedClientRunTypedRunDurablyEventの型ドキュメント不足、createDurablyHandlerオプションのドキュメント不足、フィルタセマンティクスの不明確性、useJobRunisCancelled状態の欠落といったドキュメンテーションギャップをすべて解決しています。

関連する可能性のあるプルリクエスト

  • PR #83 — 同じuseRunsフック関連のドキュメント(リターン形状とフィルタリングセマンティクス)を修正している点で直結しています。
  • PR #64createDurablyHandlerへのsseThrottleMsオプション追加という同一のAPI変更に関連しています。
  • PR #15useRunsのリターン形状(page、hasMore、nextPage、prevPage、goToPage、refresh)とフィルタセマンティクスの文書化で直接関連しています。

コード審査努力の推定

🎯 2 (Simple) | ⏱️ ~10分

📚 ウサギが駆ける、ドキュメントの道
型の形を明かしていく
TypedRunTypedClientRun
フィルタセマンティクス、きっぱり定義
APIの迷宮も、もはや謎ではなし ✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely summarizes the main objective: filling API reference documentation gaps for durably-react.
Linked Issues check ✅ Passed All coding objectives from issue #157 are met: TypedClientRun/TypedRun types added, DurablyEvent documented, createDurablyHandler options documented, useRuns pagination methods added, filter semantics clarified, and isCancelled state documented.
Out of Scope Changes check ✅ Passed All changes are directly aligned with issue #157 objectives: documentation updates for types, options tables, return types, and filter semantics with no extraneous modifications.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/react-api-reference-gaps

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

Comment @coderabbitai help to get the list of available commands and usage tips.

@vercel
Copy link
Copy Markdown

vercel Bot commented Mar 27, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
durably-demo Ready Ready Preview Mar 27, 2026 4:30pm
1 Skipped Deployment
Project Deployment Actions Updated (UTC)
durably-demo-vercel-turso Ignored Ignored Preview Mar 27, 2026 4:30pm

@coji coji merged commit 3b9b05d into main Mar 27, 2026
5 checks passed
@coji coji deleted the docs/react-api-reference-gaps branch March 27, 2026 16:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: durably-react website API reference gaps

1 participant