Repository navigation
docs(http-server-js): Add JSDoc for server emitter APIs [skip chg] - #12250
Merged
Timothee Guerin (timotheeguerin) merged 1 commit intoOct 16, 2026
Merged
Timothee Guerin (timotheeguerin) merged 1 commit into
Timothee Guerin (timotheeguerin) merged 1 commit into
Conversation
commit: |
29 of 30 tasks
|
You can try these changes here
|
Timothee Guerin (timotheeguerin)
marked this pull request as ready for review
October 16, 2026 13:44
Timothee Guerin (timotheeguerin)
requested review from
catalinaperalta,
iscai-msft,
Laurent Mazuel (lmazuel) and
Mark Cowlishaw (markcowl)
as code owners
October 16, 2026 13:44
Contributor
There was a problem hiding this comment.
🟢 Approval recommended
The documentation matches existing behavior, with no unresolved findings or functional changes.
0 open findings
What changed in this PR
Adds public API JSDoc for the JavaScript server emitter as part of #12228, without changing runtime behavior or API signatures.
Changes:
- Documents emitter options and defaults.
- Explains
$libregistration and$onEmitoutput ownership, dry-run behavior, and limitations.
| File | Description |
|---|---|
| packages/http-server-js/src/lib.ts | Documents emitter options, defaults, and library registration. |
| packages/http-server-js/src/index.ts | Documents emission behavior, output ownership, and failure conditions. |
🧠 Review effort: Balanced
💡 Configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Timothee Guerin (timotheeguerin)
merged commit Oct 16, 2026
1ba6b9f
into
microsoft:main
34 checks passed
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
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.
JavaScript server emitter consumers lack API guidance on how
$onEmit,$lib, and emitter options fit together. Document their roles, option defaults, generated-output ownership, dry-run behavior, and service/error limitations without changing emission behavior.Preserves the existing deprecated testing-library guidance and leaves generated helpers untouched.
Tracked in #12228.