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

fs: update param in jsdoc for createReadStream and createWriteStream #51063

Merged
merged 1 commit into from
Dec 7, 2023

Conversation

pluris
Copy link
Contributor

@pluris pluris commented Dec 5, 2023

I updated the jsdoc for createWriteStream() and createReadStream() in fs for inconsistencies with the documentation.

  • fs.createReadStream(path[, options])
    Add signal

    node/doc/api/fs.md

    Lines 2490 to 2504 in 1e31a01

    * `path` {string|Buffer|URL}
    * `options` {string|Object}
    * `flags` {string} See [support of file system `flags`][]. **Default:**
    `'r'`.
    * `encoding` {string} **Default:** `null`
    * `fd` {integer|FileHandle} **Default:** `null`
    * `mode` {integer} **Default:** `0o666`
    * `autoClose` {boolean} **Default:** `true`
    * `emitClose` {boolean} **Default:** `true`
    * `start` {integer}
    * `end` {integer} **Default:** `Infinity`
    * `highWaterMark` {integer} **Default:** `64 * 1024`
    * `fs` {Object|null} **Default:** `null`
    * `signal` {AbortSignal|null} **Default:** `null`
    * Returns: {fs.ReadStream}

  • fs.createWriteStream(path[, options])
    Add signal and highWaterMark

    node/doc/api/fs.md

    Lines 2622 to 2637 in 1e31a01

    * `path` {string|Buffer|URL}
    * `options` {string|Object}
    * `flags` {string} See [support of file system `flags`][]. **Default:**
    `'w'`.
    * `encoding` {string} **Default:** `'utf8'`
    * `fd` {integer|FileHandle} **Default:** `null`
    * `mode` {integer} **Default:** `0o666`
    * `autoClose` {boolean} **Default:** `true`
    * `emitClose` {boolean} **Default:** `true`
    * `start` {integer}
    * `fs` {Object|null} **Default:** `null`
    * `signal` {AbortSignal|null} **Default:** `null`
    * `highWaterMark` {number} **Default:** `16384`
    * `flush` {boolean} If `true`, the underlying file descriptor is flushed
    prior to closing it. **Default:** `false`.
    * Returns: {fs.WriteStream}

@nodejs-github-bot nodejs-github-bot added fs Issues and PRs related to the fs subsystem / file system. needs-ci PRs that need a full CI run. labels Dec 5, 2023
@pluris pluris force-pushed the doc/fs_jsdoc_stream branch from 53ca555 to addb49f Compare December 5, 2023 15:11
Copy link
Member

@rluvaton rluvaton left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you!

@rluvaton rluvaton added author ready PRs that have at least one approval, no pending requests for changes, and a CI started. request-ci Add this label to start a Jenkins CI on a PR. labels Dec 5, 2023
@github-actions github-actions bot removed the request-ci Add this label to start a Jenkins CI on a PR. label Dec 5, 2023
@nodejs-github-bot
Copy link
Collaborator

@nodejs-github-bot
Copy link
Collaborator

@lpinca lpinca added the commit-queue Add this label to land a pull request using GitHub Actions. label Dec 7, 2023
@nodejs-github-bot nodejs-github-bot removed the commit-queue Add this label to land a pull request using GitHub Actions. label Dec 7, 2023
@nodejs-github-bot nodejs-github-bot merged commit 42b238e into nodejs:main Dec 7, 2023
56 checks passed
@nodejs-github-bot
Copy link
Collaborator

Landed in 42b238e

RafaelGSS pushed a commit that referenced this pull request Dec 15, 2023
PR-URL: #51063
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Raz Luvaton <rluvaton@gmail.com>
Reviewed-By: Marco Ippolito <marcoippolito54@gmail.com>
Reviewed-By: Deokjin Kim <deokjin81.kim@gmail.com>
@RafaelGSS RafaelGSS mentioned this pull request Dec 15, 2023
richardlau pushed a commit that referenced this pull request Mar 25, 2024
PR-URL: #51063
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Raz Luvaton <rluvaton@gmail.com>
Reviewed-By: Marco Ippolito <marcoippolito54@gmail.com>
Reviewed-By: Deokjin Kim <deokjin81.kim@gmail.com>
@richardlau richardlau mentioned this pull request Mar 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
author ready PRs that have at least one approval, no pending requests for changes, and a CI started. fs Issues and PRs related to the fs subsystem / file system. needs-ci PRs that need a full CI run.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants