Skip to content

fix: update idleTimeout default from 10s to 30s#817

Merged
SaltyAom merged 1 commit intoelysiajs:mainfrom
Joaquimgmess:fix/idle-timeout-docs
Apr 4, 2026
Merged

fix: update idleTimeout default from 10s to 30s#817
SaltyAom merged 1 commit intoelysiajs:mainfrom
Joaquimgmess:fix/idle-timeout-docs

Conversation

@Joaquimgmess
Copy link
Copy Markdown
Contributor

@Joaquimgmess Joaquimgmess commented Mar 16, 2026

Summary

  • Updates documentation to reflect that Elysia's default idleTimeout is 30 seconds, not 10 seconds
  • The default was changed in Elysia v1.3.9 (commit 3b3700a) but the docs were never updated
  • Updates the code example to use 60s instead of 30s so it actually demonstrates increasing the timeout

Fixes elysiajs/elysia#1770

Context: PR elysiajs/elysia#1786 attempted to change the code default back to 10s, but SaltyAom decided to keep 30s and fix the docs instead.

Summary by CodeRabbit

Release Notes

  • Documentation
    • Updated idle timeout configuration documentation with revised default values and examples.
    • Code samples and configuration guides now reflect the current idle timeout defaults.

Elysia's default idleTimeout was changed to 30 seconds in v1.3.9
(commit 3b3700a) but the documentation still referenced 10 seconds.

Fixes elysiajs/elysia#1770
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Mar 16, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 516926ca-7b23-47bf-8281-213b09c9cfe6

📥 Commits

Reviewing files that changed from the base of the PR and between 1da49a4 and 0fa27fa.

📒 Files selected for processing (1)
  • docs/patterns/configuration.md

Walkthrough

Documentation update correcting the default idleTimeout value from 10 seconds to 30 seconds in the configuration guide, aligning with the actual default behavior introduced in v1.3.9.

Changes

Cohort / File(s) Summary
Documentation
docs/patterns/configuration.md
Updated default idleTimeout from 10 seconds to 30 seconds in code examples and descriptive text, including @default annotations. Code sample demonstrates idleTimeout value of 60 as an example.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related issues

  • #1770: PR directly addresses the documented discrepancy by updating the configuration guide to reflect the actual 30-second default idleTimeout instead of the previously documented 10-second value.

Poem

🐰 The docs were wrong, how sad indeed,
Thirty not ten is what we need,
The bunny fixed the discrepancy,
Now truth and code dance in harmony! ✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main change: updating documentation to reflect the correct idleTimeout default value from 10s to 30s.
Linked Issues check ✅ Passed The PR fully addresses issue #1770 by updating documentation to reflect that Elysia's idleTimeout default is 30 seconds, which aligns with the actual runtime behavior since v1.3.9.
Out of Scope Changes check ✅ Passed All changes are directly related to updating idleTimeout documentation to match the actual default value; no out-of-scope modifications detected.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
📝 Coding Plan
  • Generate coding plan for human review comments

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Tip

You can generate walkthrough in a markdown collapsible section to save space.

Enable the reviews.collapse_walkthrough setting to generate walkthrough in a markdown collapsible section.

@SaltyAom SaltyAom merged commit 33e63bf into elysiajs:main Apr 4, 2026
1 check passed
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 this pull request may close these issues.

Default idleTimeout is 30s instead of documented 10s inherited from Bun

2 participants