doc: QuicStream.direction / id is incorrectly documented as nullable #66686
Copy link
Copy link
Closed
Labels
docIssues and PRs related to Node.js documentation.Issues and PRs related to Node.js documentation.
Description
stream.direction is documented as returning 'bidi', 'uni', or null when the stream is pending or destroyed. However, the implementation always returns 'bidi' or 'uni', and the lifecycle test confirms that the direction remains available after destruction. There's also a test validating this behaviour (test/parallel/test-quic-session-stream-lifecycle.mjs:97)
Lines 2110 to 2120 in 9e6dd49
| ### `stream.direction` | |
| <!-- YAML | |
| added: v23.8.0 | |
| --> | |
| * Type: {string|null} One of `'bidi'`, `'uni'`, or `null`. | |
| The directionality of the stream, or `null` if the stream has been destroyed | |
| or is still pending. Read only. | |
The documentation should be updated to remove null from the type and description.
stream.id also has a similar remark where it claims to return null when destroyed, but it doesn't
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
docIssues and PRs related to Node.js documentation.Issues and PRs related to Node.js documentation.
Activity
[-]doc: QuicStream.direction is incorrectly documented as nullable[/-][+]doc: QuicStream.direction / id is incorrectly documented as nullable[/+]VivekDubey126 commentedon Oct 12, 2026
Hi! I’d like to work on this. I’ll look at both stream.direction and stream.id in doc/api/quic.md and open a PR shortly.
aliyasyeddd commentedon Oct 13, 2026
I'd like to work on this issue. I'll verify the behavior and update the documentation accordingly.
MikeMcC399 commentedon Oct 14, 2026
#66687 has been approved