Skip to content

docs: audit events page#14

Merged
demengc merged 1 commit intomainfrom
docs/audit-events-page
Mar 24, 2026
Merged

docs: audit events page#14
demengc merged 1 commit intomainfrom
docs/audit-events-page

Conversation

@demengc
Copy link
Copy Markdown
Owner

@demengc demengc commented Mar 24, 2026

Summary

  • Rewrote the events documentation page to match the current Events API surface after verifying every method name and signature against source code
  • Documented 6 previously missing Events.call*() dispatch methods, all 8 EventFilters predicates, both EventHandlers utilities, biHandler(), exceptionConsumer(), handleSubclasses(), expiry options with ExpiryTestStage, and merged subscriptions with manual bindEvent() mapping
  • Replaced filler comments in code examples with real handler logic, used tables for reference-style API listings, and applied informative headings throughout

Test plan

  • Verify markdown renders correctly on GitBook
  • Spot-check that all method names in the doc still match the source

Rewrite the events documentation to match the current API surface.

- Verify all method names and signatures against source
- Document Events.call(), callAsync(), callSync(), callAndReturn(),
  callAsyncAndJoin(), callSyncAndJoin() (previously undocumented)
- Document EventFilters utility (8 built-in filter methods)
- Document EventHandlers utility (cancel/uncancel)
- Document expiry options with ExpiryTestStage enum values
- Document biHandler(), exceptionConsumer(), handleSubclasses()
- Document merged subscriptions with manual bindEvent() mapping
- Replace inline comments with actual handler logic in examples
- Use tables for reference-style API listings
- Use informative headings throughout
@demengc demengc merged commit 864fcad into main Mar 24, 2026
2 of 3 checks passed
@demengc demengc deleted the docs/audit-events-page branch March 24, 2026 02:00
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.

1 participant