fix(offline): keep prepared batches linear - #58
Conversation
✅ Deploy Preview for rdlabo-ionic-angular-library ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
| export interface PreparedOfflineBatchOptions { | ||
| flush?: boolean; | ||
| /** Product identity/scope lease asserted after all async preparation and immediately before the durable commit. */ | ||
| assertCurrent?: () => void; | ||
| } |
There was a problem hiding this comment.
🟡 新しく公開された設定用の型に説明コメントが付いていない
公開APIとして追加された設定の型に説明コメントが付いていない(PreparedOfflineBatchOptions at projects/kit/offline/src/lib/offline-sync.service.ts:76)ため、リポジトリ規約(AGENTS.md「Every public class, function, and type must have a JSDoc comment.」)に違反しています。
Impact: 利用者向けドキュメントが欠落し、公開パッケージの説明が不揃いになります。
規約と該当箇所
AGENTS.md の「When modifying this repo」項目3で、すべての public な class / function / type に JSDoc を必須としています。同ファイル内の他の公開型(projects/kit/offline/src/lib/offline-sync.service.ts:66-74 の PreparedOfflineCommand など)は JSDoc を持っており、export * from './lib/offline-sync.service'(projects/kit/offline/src/public-api.ts:18)により本型も公開APIとして出力されます。メンバー assertCurrent にはコメントがありますが、型自体にはありません。
| export interface PreparedOfflineBatchOptions { | |
| flush?: boolean; | |
| /** Product identity/scope lease asserted after all async preparation and immediately before the durable commit. */ | |
| assertCurrent?: () => void; | |
| } | |
| /** Options for committing a prepared batch of Outbox commands in one serialized transaction. */ | |
| export interface PreparedOfflineBatchOptions { | |
| flush?: boolean; | |
| /** Product identity/scope lease asserted after all async preparation and immediately before the durable commit. */ | |
| assertCurrent?: () => void; | |
| } |
Was this helpful? React with 👍 or 👎 to provide feedback.
Summary
Verification