Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation Update: emptyTimeout in CreateOptions #126

Open
punitsu opened this issue Jan 8, 2024 · 0 comments · May be fixed by #127
Open

Documentation Update: emptyTimeout in CreateOptions #126

punitsu opened this issue Jan 8, 2024 · 0 comments · May be fixed by #127

Comments

@punitsu
Copy link

punitsu commented Jan 8, 2024

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;
@punitsu punitsu linked a pull request Jan 8, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant