Skip to content

Improve emptyTimeout and departureTimeout JSDoc comments #626

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.

Sign up for GitHub

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

Open
ctonneslan wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Improve emptyTimeout and departureTimeout JSDoc comments #626

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions packages/livekit-server-sdk/src/RoomServiceClient.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,13 +38,19 @@ export interface CreateOptions {
name: string;

/**
* number of seconds to keep the room open before any participant joins
* Number of seconds to keep the room open when empty.
*
* Before any participant joins, the room will close after this timeout.
* After all participants leave, the countdown restarts. If a new participant
* joins before it elapses, the timer resets and the room stays open.
*/
emptyTimeout?: number;

/**
* number of seconds to keep the room open after the last participant leaves
* this option is helpful to give a grace period for participants to re-join
* Number of seconds to keep the room open after the last participant leaves.
*
* This provides a grace period for participants to re-join (e.g. after a
* brief disconnection) without the room being closed and recreated.
*/
departureTimeout?: number;

Expand Down
Loading