Skip to content

Clarify information about using highWaterMark option in fs.createWriteStream #49420

Closed

Description

@wszydlak

Affected URL(s)

No response

Description of the problem

API docs for fs.createWriteStream don't mention option highWaterMark.
However according to source code and tests (https://github.com/nodejs/node/blob/main/test/parallel/test-file-write-stream2.js#L67) this option is valid and passed to stream.Writable, so developers can use them.

In @types/node package this option is not available (as types covers API docs) so i cannot use this option when writing code in typescript.

Please clarify if fs.createWriteStream can take highWaterMark and if so - it should be documented in API docs.

Activity

  1. added
    docIssues and PRs related to Node.js documentation.
    on Aug 31, 2023
  2. added
    good first issueIssues that are suitable for first-time contributors.
    fsIssues and PRs related to file-system APIs and the fs module.
    on Sep 1, 2023
  3. ariel-weiss commented on Sep 1, 2023

    @ariel-weiss
    Contributor

    I'd happy to take this issue

  4. sharma62 commented on Sep 5, 2023

    @sharma62

    I am glad to resolve the issue.

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.fsIssues and PRs related to file-system APIs and the fs module.good first issueIssues that are suitable for first-time contributors.

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions