Add missing RestAnnotation#delete typings

[SimonWoolf]

just noticed these were missing from the d.ts

Summary by CodeRabbit

• Documentation
  • Added two deletion overloads for annotation removal in the REST annotations API and included JSDoc describing delete semantics and required fields.
• Style
  • Updated formatting and documentation structure in type definitions to improve consistency.

[coderabbitai]

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: 9452c1b6-e2f2-45ec-81bc-2b7e602b4bea

📥 Commits

Reviewing files that changed from the base of the PR and between cecf59a and 5a8adb0.

📒 Files selected for processing (1)

• ably.d.ts

---

Walkthrough

Two new TypeScript declaration overloads were added to the RestAnnotations interface in ably.d.ts: delete(message: Message, annotation: OutboundAnnotation): Promise<void> and delete(messageSerial: string, annotation: OutboundAnnotation): Promise<void>. No runtime logic changed.

Changes

TypeScript Declaration Update

Layer / File(s)	Summary
RestAnnotations.delete overloads ably.d.ts	Added two delete overload signatures with JSDoc to RestAnnotations: (message: Message, annotation: OutboundAnnotation): Promise<void> and (messageSerial: string, annotation: OutboundAnnotation): Promise<void>.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐰 I nudged two lines in tidy rows,
Signatures planted where TypeScript grows,
Quiet change, no runtime hop,
Just clearer types — and then I stop. 🥕

🚥 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 accurately and concisely describes the primary change: adding TypeScript type definitions for the RestAnnotation#delete method that were previously missing.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

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

✨ Finishing Touches

📝 Generate docstrings

• Create stacked PR
• Commit on current branch

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch annotation-delete-typings

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

[ttypic]

LGTM

[coderabbitai]

Actionable comments posted: 0