Skip to content

doc: QuicStream.direction / id is incorrectly documented as nullable #66686

Open

Description

@efekrskl

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)

node/doc/api/quic.md

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

Activity

  1. added
    good first issueIssues that are suitable for first-time contributors.
    docIssues and PRs related to Node.js documentation.
    on Oct 12, 2026
  2. changed the title [-]doc: QuicStream.direction is incorrectly documented as nullable[/-] [+]doc: QuicStream.direction / id is incorrectly documented as nullable[/+] on Oct 12, 2026
  3. VivekDubey126 commented on Oct 12, 2026

    @VivekDubey126

    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.

  4. aliyasyeddd commented on Oct 13, 2026

    @aliyasyeddd

    I'd like to work on this issue. I'll verify the behavior and update the documentation accordingly.

  5. removed
    good first issueIssues that are suitable for first-time contributors.
    on Oct 13, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    docIssues and PRs related to Node.js documentation.

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions