#Room Configuration

Rooms are defined in the DialogueConfig.rooms object, keyed by room ID.

#Basic Room Configuration

import { createDialogue, defineEvent } from "./dialogue";

const Message = defineEvent("message");
const Typing = defineEvent("typing");

const dialogue = createDialogue({
  rooms: {
    chat: {
      name: "Chat Room",
      events: [Message, Typing],
    },
  },
});

#Room Configuration Options

#Bounded Rooms

Limit concurrent connections for predictable scaling:

const dialogue = createDialogue({
  rooms: {
    game: {
      name: "Game Lobby",
      events: [GameState, PlayerMove],
      maxSize: 4, // Max 4 players per game
    },
  },
});

When a room is full, new clients receive a dialogue:error event with code ROOM_FULL.

#Default Subscriptions

Auto-subscribe clients to specific events when they join:

const dialogue = createDialogue({
  rooms: {
    notifications: {
      name: "Notifications",
      events: [Alert, Message, SystemUpdate],
      defaultSubscriptions: ["alert", "message"], // Skip system-update by default
    },
  },
});

#Event Control Patterns

Accept All Events (Wildcard):

To create a room that accepts any event type, use the wildcard "*":

const dialogue = createDialogue({
  rooms: {
    sandbox: {
      name: "Sandbox",
      events: [{ name: '*' }],  // Accepts any event name
      defaultSubscriptions: ['*']  // Subscribe to all events
    },
  },
});

Reject All Events (Empty Array):

To create a room that rejects all trigger attempts (listen-only or system-controlled):

const dialogue = createDialogue({
  rooms: {
    readonly: {
      name: "Read-Only Notifications",
      events: [],  // No events can be triggered by clients
      // Server can still push via dialogue.trigger() if needed
    },
  },
});

How it works:

• events: [] - No events allowed (all triggers rejected)
• events: [{ name: '*' }] - All events allowed (no validation)
• events: [specificEvent1, specificEvent2] - Only listed events allowed
• defaultSubscriptions: ['*'] - Clients auto-subscribe to all events when joining

Use cases:

• Wildcard (*): Chat rooms, debug channels, flexible communication
• Empty array ([]): Read-only rooms, server-only broadcasting
• Specific events: Most production use cases with validated schemas

Warning: Wildcard rooms bypass event validation. Use with caution in production.

#See Also

• Event Definitions - Defining events for rooms
• Lifecycle Hooks - Room access control with beforeJoin hook
• Dialogue Configuration - Full configuration example