Skip to content

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

Closed
@wszydlak

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    docIssues and PRs related to the documentations.fsIssues and PRs related to the fs subsystem / file system.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