wps-events

What problem does it solve?

This Skill provides comprehensive guidance on using Wave Terminal's Publish-Subscribe (WPS) event system, enabling asynchronous communication between different application components.

Core Features & Use Cases

• Event System Overview: Understand the WPS broker pattern for routing events.
• Event Structure: Learn the format of WaveEvent including event type, scopes, sender, persistence, and data payload.
• Adding New Events: Step-by-step instructions for defining new event constants, registering them, and exposing event data types for frontend use.
• Publishing & Subscribing: Detailed examples for publishing events with and without scopes, asynchronous publishing, and subscribing to events from Go code.
• Best Practices: Guidelines on using namespaces, avoiding blocking, type-safe data, scoping, documentation, and event persistence.
• Use Case: When developing a new feature that needs to notify other parts of the application about a change (e.g., a block being closed, a connection status update), this Skill guides you on how to properly define, publish, and subscribe to these events.

Quick Start

Follow the guide to add a new event type named 'my:newevent' with no associated data.