Skip to content

doc: fix QuicStream direction and id nullability docs - #66688

Open
VivekDubey126 wants to merge 1 commit into
nodejs:mainfrom
VivekDubey126:doc-quic-stream-direction-id
Open

VivekDubey126 wants to merge 1 commit into
nodejs:mainfrom
VivekDubey126:doc-quic-stream-direction-id

Conversation

@VivekDubey126

Copy link
Copy Markdown

Fixes: #66686

  • stream.direction never returns null (it always returns 'bidi'
    or 'uni'), so the type is now {string}.
  • stream.id returns null only while the stream is pending
    (lib/internal/quic/quic.js), so that case is kept and the
    "destroyed" claim is removed.
  • After destruction, stream.id appears to return undefined
    because the state handle is cleared. I did not document this, to
    keep the change minimal.

@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

Review requested:

  • @nodejs/quic

@nodejs-github-bot nodejs-github-bot added doc Issues and PRs related to Node.js documentation. quic Issues and PRs related to the QUIC transport implementation. labels Oct 12, 2026
@github-actions

Copy link
Copy Markdown
Contributor

Welcome to Node.js, and thank you for your first contribution!

Before review, please take a moment to read:

Please make sure every commit is signed off. For a first pull request, GitHub Actions require collaborator approval and Jenkins CI must be started by a collaborator or triager, so an initial wait is normal.

@inoway46

Copy link
Copy Markdown
Contributor

This appears to be a duplicate of #66687. Could you close this PR?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

doc Issues and PRs related to Node.js documentation. quic Issues and PRs related to the QUIC transport implementation.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

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

3 participants