Skip to content

Documentation Update: emptyTimeout in CreateOptions #126

Open
@punitsu

Description

@punitsu

Current Documentation

/**
 * number of seconds the room should clean up after being empty
 */
emptyTimeout?: number;

Proposed Documentation

  /**
   * The `emptyTimeout` property represents the number of seconds a room should remain open after being empty.
   *
   * Behavior:
   * 1. When creating a room with an `emptyTimeout` of, for example, 10 minutes:
   *    - If no participant joins within 20 seconds of room creation, the room will automatically close.
   *
   * 2. If a participant joins and later disconnects:
   *    - The empty timeout countdown begins only after the last participant disconnects.
   *    - If the last participant disconnects and no new participant joins, the room will continue to exist for the
   *      specified `emptyTimeout` duration (e.g., 10 minutes) before automatically closing.
   *    - If a new participant joins before the empty timeout elapses, the countdown is reset, and the room remains open.
   */
  emptyTimeout?: number;

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions