docs(client): fix notifications.list README example to use real read option - #7194
Conversation
…option
The README's only usage example for client.notifications.list showed
{ unreadOnly: true }, a key the implementation has never read. The real
options are { read?, type?, limit? }; replace the example with
{ read: false } (the semantic equivalent of unread-only).
Fixes #6927
|
The latest updates on your projects. Learn more about Vercel for GitHub. 1 Skipped Deployment
|
📓 Docs Drift CheckThis PR changes 1 package(s): 11 hand-written doc(s) reference the affected code and may need an implementation-accuracy re-verification:
⛔ 3 release-owned page(s) also reference the affected code. These are read-only:
|
Fixes #6927
packages/client/README.md's only usage example forclient.notifications.listshowed{ unreadOnly: true }. That key has never existed in the implementation —packages/client/src/index.tsdeclares the real options as{ read?: boolean; type?: string; limit?: number }, andunreadOnlyis read by nothing on either client or server. An author (or AI author) copying the example gets a silently ignored key and an unfiltered list.Change
Replaced the example with the semantic equivalent using the real option:
Scope
Single-hunk, README-only change. Grepped all of
packages/clientfor otherunreadOnlyoccurrences — none found outside this one line.No behavior change, no changeset needed (docs-only).
Generated by Claude Code
Generated by Claude Code