Skip to content

doc: description for chunks in _writev in stream_writable #36789

Closed

Description

@codati

📗 API Reference Docs Problem

  • Version: v12.18.3
  • Platform: 5.9.0-5-amd64 #1 SMP Debian 5.9.15-1 (2020-12-17) x86_64 GNU/Linux
  • Subsystem: stream

Location

Affected URL(s):

Description

descrition of params chunks does not correspond to what gives me a console.log

[
  {
    chunk: <Buffer ff ff>,
    encoding: 'buffer',
    callback: [Function: nop],
    next: {
      chunk: <Buffer ff ff>,
      encoding: 'buffer',
      callback: [Function: nop],
      next: [Object]
    }
  },
  {
    chunk: <Buffer ff ff>,
    encoding: 'buffer',
    callback: [Function: nop],
    next: {
      chunk: <Buffer ff ff>,
      encoding: 'buffer',
      callback: [Function: nop],
      next: [Object]
    }
  },
  {
    chunk: <Buffer ff ff>,
    encoding: 'buffer',
    callback: [Function: nop],
    next: {
      chunk: <Buffer ff ff>,
      encoding: 'buffer',
      callback: [Function: nop],
      next: null
    }
  },
  {
    chunk: <Buffer ff ff>,
    encoding: 'buffer',
    callback: [Function: nop],
    next: null
  },
  allBuffers: true
]

I can call callback in chunks object? or call callback in 2nd parameter?
What is allBuffers?

thank you for taking the time to read my request (:

Activity

  1. added
    docIssues and PRs related to Node.js documentation.
    on Jan 4, 2021
  2. GrosSacASac commented on Jan 5, 2021

    @GrosSacASac
    Contributor

    I am not the author but here is my explanation: chunk and encoding are documented and should be used. the rest is not documented and therefore should not be used. It is an implementation detail.

  3. PoojaDurgad commented on Jan 6, 2021

    @PoojaDurgad
    Contributor

    @codati - can you share your code please? I am not able to see the additional fields which you shared.

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