Emit — Reference
Send a named event to connected clients, optionally limited by namespace and room.
Send a named event to connected clients, optionally limited by namespace and room.
Before you begin
Section titled “Before you begin”- A Node.js project with Socket.IO configured and connected test clients. Socket-specific operations must run in a socket action.
Send a named event to connected clients, optionally limited by namespace and room.
Settings
Section titled “Settings”| Setting | Meaning |
|---|---|
| Name | The step identifier used for results in the server action. Sending/joining steps do not return a delivery receipt merely because they have a name. |
| Namespace | The Socket.IO namespace to target. Leave empty for the default namespace; it is separate from a room within that namespace. |
| Room | The application room to target, join or leave. Use a server-approved room name. A room is a routing group, not an authentication permission. |
| Type | The event/action type selected from the socket definitions. This becomes the emitted eventName, not a primitive data type such as text or number. |
| Input Parameters | Fields generated from the chosen event/action’s $_PARAM definition. Their names and values become the sent parameters. Changing the selected definition clears the earlier parameter mapping; recheck it before testing. |
Verification example
Section titled “Verification example”Connect two disposable test clients listening for the same event type. Emit a small test payload to their namespace and verify receipt. Add a room filter and confirm that only joined clients receive it.
Context and delivery limits
Section titled “Context and delivery limits”Emit uses the server Socket.IO instance and can include the originating client. It does not persist a message or guarantee that a disconnected client will later receive it. Select recipients deliberately before sending private data.
Connect to page behavior
Section titled “Connect to page behavior”Use client event handlers or the appropriate Server Connect subscription to update the page. Keep authorization, persistence and event delivery as explicit parts of the workflow.
Check your result
Section titled “Check your result”You can choose the intended recipients/context and verify the event or room behavior with test clients.