Improve emptyTimeout and departureTimeout JSDoc comments#626
Open
ctonneslan wants to merge 1 commit intolivekit:mainfrom
Open
Improve emptyTimeout and departureTimeout JSDoc comments#626ctonneslan wants to merge 1 commit intolivekit:mainfrom
ctonneslan wants to merge 1 commit intolivekit:mainfrom
Conversation
Clarify the behavior of emptyTimeout: it applies both before any participant joins and after all participants leave, with the timer resetting when someone joins. Also improve departureTimeout docs with a concrete use case. Fixes livekit#126
|
![devin-ai-integration[bot]](https://avatars.githubusercontent.com/in/811515?s=60&v=4){kind=small}
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #126
The existing docs for
emptyTimeoutjust said "number of seconds to keep the room open before any participant joins" which doesn't cover the full behavior. It actually applies after all participants leave too, and the timer resets when someone joins.Updated both
emptyTimeoutanddepartureTimeoutdocs to be clearer about the lifecycle. Kept it concise since these are JSDoc comments, not a full guide.