API Reference
Audience: users.
This section documents the intended API contract for the pre-v1.0 phase.
Contract Scope
Section titled “Contract Scope”- Package namespace:
@roomful/* - Source of truth for documented signatures: this
reference/section - Stability: contract may evolve before
v1.0
When implementation and docs differ, open an issue with:
- package name
- observed behavior
- expected contract
- reproduction steps
Reference Pages
Section titled “Reference Pages”- Core API
- Presence engine
- Cursor engine
- State, awareness, events
- React adapter
- Vue adapter
- Svelte adapter
- Advanced features
- UI components
- Devtools and debugging
- Performance
- Type reference