Skip to content

Docs missing for http2Stream.id and the 'ready' event #22804

Closed
Closed
Docs missing for http2Stream.id and the 'ready' event#22804
Labels
docIssues and PRs related to Node.js documentation.good first issueIssues that are suitable for first-time contributors.help wantedIssues that need assistance from volunteers or PRs that need help to proceed.http2Issues and PRs related to the http2 subsystem.

Description

@jakearchibald
jakearchibald
opened on Sep 11, 2018

I wrote a piece of code that made a request to A, and after a moment, made a request to B with the prior stream as a parent.

This means I needed to pass the ID of stream A to the client.request call for stream B.

stream.id is mentioned in passing, but it isn't specifically documented.

Same goes for the ready event.

Activity

  1. Trott commented on Nov 4, 2018

    @Trott
    Trott
    on Nov 4, 2018
    Member

    @nodejs/documentation @nodejs/http2

  2. ryzokuken commented on Nov 4, 2018

    @ryzokuken
    ryzokuken
    on Nov 4, 2018
    Contributor

    I tried to do something like this in nodejs/help#877 (comment), but was stalled. Perhaps we could break these into a couple of "good second issue"s?

  3. ryzokuken commented on Nov 4, 2018

    @ryzokuken
    ryzokuken
    on Nov 4, 2018
    Contributor

    /cc @mcollina

  4. mcollina commented on Nov 4, 2018

    @mcollina
    mcollina
    on Nov 4, 2018
    SponsorMember

    stream.id is the HTTP2 Stream id.

    ready is emitted when an id is available.

  5. jasnell
    added
    docIssues and PRs related to Node.js documentation.
    http2Issues and PRs related to the http2 subsystem.
    good first issueIssues that are suitable for first-time contributors.
    help wantedIssues that need assistance from volunteers or PRs that need help to proceed.
    on Jun 26, 2020
  6. jasnell
    added a commit that references this issue on Jul 6, 2020

    doc: document the ready event for Http2Stream

    56bb548
  7. jasnell
    closed this as completedin f98a441on Jul 9, 2020
  8. addaleax
    added 2 commits that reference this issue on Sep 22, 2020

    doc: document the ready event for Http2Stream

    5ce4935

    doc: document the ready event for Http2Stream

    2615e55
  9. sjarmak
    added a commit that references this issue on Jul 27, 2026

    doc: document the ready event for Http2Stream

    f98a441
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.good first issueIssues that are suitable for first-time contributors.help wantedIssues that need assistance from volunteers or PRs that need help to proceed.http2Issues and PRs related to the http2 subsystem.

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions