GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — fs: update param in jsdoc for `createReadStream` and `createWriteStream` by pluris · Pull Request #51063 · nodejs/node

Conversation

@pluris

@pluris pluris commented Dec 5, 2023 •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Contributor

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}

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

bricss reacted with thumbs up emoji
All reactions
  • 👍 1 reaction
@nodejs-github-bot nodejs-github-bot added fs Issues and PRs related to file-system APIs and the fs module. needs-ci PRs that need a full CI run. labels Dec 5, 2023
pluris
fs: update params in jsdoc for createReadStream and createWriteStream
addb49f
@pluris
pluris force-pushed the doc/fs_jsdoc_stream branch from 53ca555 to addb49f Compare December 5, 2023 15:11
lpinca
lpinca approved these changes Dec 5, 2023
View reviewed changes
rluvaton
rluvaton approved these changes Dec 5, 2023
View reviewed changes

@rluvaton rluvaton left a comment

Copy link
Copy Markdown
Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

Thank you!

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

pluris reacted with thumbs up emoji
All reactions
  • 👍 1 reaction
@rluvaton rluvaton added author ready PRs with CI started, the required approvals, and no outstanding review comments. request-ci Add this label to start a Jenkins CI on a PR. Only starts once the PR has an approving review. labels Dec 5, 2023
@github-actions github-actions Bot removed the request-ci Add this label to start a Jenkins CI on a PR. Only starts once the PR has an approving review. label Dec 5, 2023
@nodejs-github-bot

nodejs-github-bot commented Dec 5, 2023

Copy link
Copy Markdown
Collaborator

CI: https://ci.nodejs.org/job/node-test-pull-request/56114/

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

marco-ippolito
marco-ippolito approved these changes Dec 6, 2023
View reviewed changes
deokjinkim
deokjinkim approved these changes Dec 6, 2023
View reviewed changes
@nodejs-github-bot

nodejs-github-bot commented Dec 6, 2023

Copy link
Copy Markdown
Collaborator

CI: https://ci.nodejs.org/job/node-test-pull-request/56130/

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@lpinca lpinca added the commit-queue PRs queued for automated landing through the Commit Queue. label Dec 7, 2023
@nodejs-github-bot nodejs-github-bot removed the commit-queue PRs queued for automated landing through the Commit Queue. label Dec 7, 2023
@nodejs-github-bot
nodejs-github-bot merged commit 42b238e into nodejs:main Dec 7, 2023
@nodejs-github-bot

nodejs-github-bot commented Dec 7, 2023

Copy link
Copy Markdown
Collaborator

Landed in 42b238e

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

RafaelGSS pushed a commit that referenced this pull request Dec 15, 2023
Jungku Lee @RafaelGSS
fs: update params in jsdoc for createReadStream and createWriteStream
c3c8237
PR-URL: #51063
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Raz Luvaton <[email protected]>
Reviewed-By: Marco Ippolito <[email protected]>
Reviewed-By: Deokjin Kim <[email protected]>
@RafaelGSS RafaelGSS mentioned this pull request Dec 15, 2023
v21.5.0 proposal #51166
Merged
richardlau pushed a commit that referenced this pull request Mar 25, 2024
Jungku Lee @richardlau
fs: update params in jsdoc for createReadStream and createWriteStream
bac982b
PR-URL: #51063
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Raz Luvaton <[email protected]>
Reviewed-By: Marco Ippolito <[email protected]>
Reviewed-By: Deokjin Kim <[email protected]>
@richardlau richardlau mentioned this pull request Mar 25, 2024
v20.12.0 proposal #52212
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@lpinca lpinca lpinca approved these changes
@deokjinkim deokjinkim deokjinkim approved these changes
@rluvaton rluvaton rluvaton approved these changes
@marco-ippolito marco-ippolito marco-ippolito approved these changes

Uh oh!

There was an error while loading. Please reload this page.

Assignees

No one assigned

Labels

author ready PRs with CI started, the required approvals, and no outstanding review comments. fs Issues and PRs related to file-system APIs and the fs module. needs-ci PRs that need a full CI run.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Uh oh!

There was an error while loading. Please reload this page.

6 participants

@pluris @nodejs-github-bot @lpinca @deokjinkim @rluvaton @marco-ippolito
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.