Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: description for chunks in _writev in stream_writable #36789

Closed
codati opened this issue Jan 4, 2021 · 2 comments
Closed

doc: description for chunks in _writev in stream_writable #36789

codati opened this issue Jan 4, 2021 · 2 comments
Labels
doc Issues and PRs related to the documentations.

Comments

@codati
Copy link

codati commented Jan 4, 2021

📗 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 (:

@codati codati added the doc Issues and PRs related to the documentations. label Jan 4, 2021
@GrosSacASac
Copy link
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.

@PoojaDurgad
Copy link
Contributor

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

jasnell added a commit to jasnell/node that referenced this issue Jan 8, 2021
@jasnell jasnell closed this as completed in 96c3498 Jan 9, 2021
danielleadams pushed a commit that referenced this issue Jan 12, 2021
Fixes: #36789
Signed-off-by: James M Snell <[email protected]>

PR-URL: #36822
Reviewed-By: Matteo Collina <[email protected]>
Reviewed-By: Anto Aravinth <[email protected]>
Reviewed-By: Daijiro Wachi <[email protected]>
targos pushed a commit that referenced this issue May 1, 2021
Fixes: #36789
Signed-off-by: James M Snell <[email protected]>

PR-URL: #36822
Reviewed-By: Matteo Collina <[email protected]>
Reviewed-By: Anto Aravinth <[email protected]>
Reviewed-By: Daijiro Wachi <[email protected]>
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 the documentations.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants