Type Parameters

Hierarchy

  • Room

Constructors

Properties

binaryMessageBus: any
isProcessingQueue: boolean = false
isRoomReadyAtom: Atom<boolean>
isServerFuture: IFuture<boolean> = ...
listeners: Map<keyof T, Set<EventCallback<any>>> = ...
messageQueue: QueuedMessage<T>[] = []

Methods

  • Remove all listeners for a specific event type

    Type Parameters

    • K extends string | number | symbol

    Parameters

    • Optional eventType: K

      The type of event to clear listeners for

    Returns void

  • Get the number of listeners for an event type

    Returns

    Number of registered listeners

    Type Parameters

    • K extends string | number | symbol

    Parameters

    • eventType: K

      The type of event to check

    Returns number

  • Listen for an event

    Returns

    Unsubscribe function

    Type Parameters

    • K extends string | number | symbol

    Parameters

    • eventType: K

      The type of event to listen for

    • callback: EventCallback<EventTypes<T>[K]>

      Callback to handle the event

    Returns (() => void)

      • (): void
      • Listen for an event

        Returns

        Unsubscribe function

        Returns void

  • Subscribe to room readiness changes

    Returns

    Unsubscribe function

    Example

    const unsubscribe = room.onReady((isReady) => {
    if (isReady) {
    console.log('Room connected!')
    } else {
    console.log('Room disconnected')
    }
    })

    // Later: unsubscribe()

    Parameters

    • callback: ((isReady: boolean) => void)

      Called when room becomes ready or disconnected

        • (isReady: boolean): void
        • Parameters

          • isReady: boolean

          Returns void

    Returns (() => void)

      • (): void
      • Subscribe to room readiness changes

        Returns

        Unsubscribe function

        Example

        const unsubscribe = room.onReady((isReady) => {
        if (isReady) {
        console.log('Room connected!')
        } else {
        console.log('Room disconnected')
        }
        })

        // Later: unsubscribe()

        Returns void

  • Send an event

    Type Parameters

    • K extends string | number | symbol

    Parameters

    • eventType: K

      The type of event from the registry

    • data: EventTypes<T>[K]

      The event data matching the schema

    • Optional options: SendOptions

      Optional send options (server only)

      Messages are automatically queued if the room is not ready and sent once connected.

    Returns Promise<void>