Skip to content

docs: improve JSDoc parameter descriptions for Application constructor - #1941

Open
kshitijanurag wants to merge 1 commit into
koajs:masterfrom
kshitijanurag:master
Open

docs: improve JSDoc parameter descriptions for Application constructor#1941
kshitijanurag wants to merge 1 commit into
koajs:masterfrom
kshitijanurag:master

Conversation

@kshitijanurag

@kshitijanurag kshitijanurag commented Mar 16, 2026

Copy link
Copy Markdown

Improve JSDoc and docs for Application constructor options

  • lib/application.js: improve JSDoc param descriptions
    • add missing defaults
    • update wording for proxy parameter
    • fix asyncLocalStorage type and description
  • docs/api/index.md:
    • add missing app.compose entry
  • docs/api/context.md: update stale Node.js docs URL

Checklist

  • I have ensured my pull request is not behind the main or master branch of the original repository.
  • I have rebased all commits where necessary so that reviewing this pull request can be done without having to merge it first.
  • I have written a commit message that passes commitlint linting.
  • I have ensured that my code changes pass linting tests.
  • I have ensured that my code changes pass unit tests.
  • I have described my pull request and the reasons for code changes along with context if necessary.

Summary by CodeRabbit

  • Documentation
    • Updated the Node.js Events API reference link.
    • Added and clarified application settings documentation, including app.compose, proxy and subdomain defaults, and async local storage configuration.
    • Improved descriptions of application options and their default values.
    • Clarified app.currentContext documentation and formatting.

@codecov

codecov Bot commented Mar 16, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 99.90%. Comparing base (52d5e8f) to head (67a0d68).

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #1941   +/-   ##
=======================================
  Coverage   99.90%   99.90%           
=======================================
  Files           9        9           
  Lines        2109     2109           
=======================================
  Hits         2107     2107           
  Misses          2        2           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@coderabbitai

coderabbitai Bot commented Jul 24, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

Updated Koa’s application option documentation in constructor JSDoc and API references. The changes document app.compose, clarify defaults for proxy and subdomain settings, describe enabling async local storage with true or an AsyncLocalStorage instance, format AsyncLocalStorage consistently, and replace an outdated Node.js Events API link. No runtime behavior changed.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main docs-focused change to the Application constructor JSDoc.

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.

@kshitijanurag

Copy link
Copy Markdown
Author

@fengmk2 Do you mind taking a look on this one?

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.

1 participant