Skip to content

Commit e5ecc5e

Browse files
os-helpclaude
andauthored
docs(client): fix notifications.list README example to use real read option (#7194)
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 Co-authored-by: Claude <noreply@anthropic.com>
1 parent 42da73d commit e5ecc5e

1 file changed

Lines changed: 1 addition & 1 deletion

File tree

packages/client/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -256,7 +256,7 @@ await client.approvals.approve(requestId, 'LGTM');
256256
await client.approvals.reject(requestId, 'Incomplete');
257257

258258
// Notifications
259-
await client.notifications.list({ unreadOnly: true });
259+
await client.notifications.list({ read: false }); // unread only
260260
await client.notifications.markRead(['notif-1', 'notif-2']);
261261

262262
// AI Services

0 commit comments

Comments
 (0)