Skip to content

fs: update jsdoc for filehandle.createWriteStream and appendFile #51494

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Jan 20, 2024
Merged

fs: update jsdoc for filehandle.createWriteStream and appendFile #51494

merged 1 commit into from
Jan 20, 2024

Conversation

@pluris
Copy link
Contributor

@pluris pluris commented Jan 16, 2024

I updated jsdoc due to inconsistency between documentation and jsdoc.

  • filehandle.createWriteStream()

    node/doc/api/fs.md

    Lines 336 to 344 in e133e51

    * `options` {Object}
    * `encoding` {string} **Default:** `'utf8'`
    * `autoClose` {boolean} **Default:** `true`
    * `emitClose` {boolean} **Default:** `true`
    * `start` {integer}
    * `highWaterMark` {number} **Default:** `16384`
    * `flush` {boolean} If `true`, the underlying file descriptor is flushed
    prior to closing it. **Default:** `false`.
    * Returns: {fs.WriteStream}

  • fs.appendFile()

    node/doc/api/fs.md

    Lines 2105 to 2114 in e133e51

    * `path` {string|Buffer|URL|number} filename or file descriptor
    * `data` {string|Buffer}
    * `options` {Object|string}
    * `encoding` {string|null} **Default:** `'utf8'`
    * `mode` {integer} **Default:** `0o666`
    * `flag` {string} See [support of file system `flags`][]. **Default:** `'a'`.
    * `flush` {boolean} If `true`, the underlying file descriptor is flushed
    prior to closing it. **Default:** `false`.
    * `callback` {Function}
    * `err` {Error}

@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 Jan 16, 2024
@deokjinkim deokjinkim added request-ci Add this label to start a Jenkins CI on a PR. author ready PRs that have at least one approval, no pending requests for changes, and a CI started. labels Jan 20, 2024
@github-actions github-actions bot removed the request-ci Add this label to start a Jenkins CI on a PR. label Jan 20, 2024
@nodejs-github-bot
Copy link
Collaborator

nodejs-github-bot commented Jan 20, 2024

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

@nodejs-github-bot
Copy link
Collaborator

nodejs-github-bot commented Jan 20, 2024

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

@nodejs-github-bot
Copy link
Collaborator

nodejs-github-bot commented Jan 20, 2024

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

@deokjinkim deokjinkim added the commit-queue Add this label to land a pull request using GitHub Actions. label Jan 20, 2024
@nodejs-github-bot nodejs-github-bot removed the commit-queue Add this label to land a pull request using GitHub Actions. label Jan 20, 2024
@nodejs-github-bot nodejs-github-bot merged commit 27d839f into nodejs:main Jan 20, 2024
@nodejs-github-bot
Copy link
Collaborator

nodejs-github-bot commented Jan 20, 2024

Landed in 27d839f

marco-ippolito pushed a commit to marco-ippolito/node that referenced this pull request Feb 2, 2024
@marco-ippolito
fs: update jsdoc for filehandle.createWriteStream and appendFile
ba5781c 
PR-URL: nodejs#51494
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Deokjin Kim <deokjin81.kim@gmail.com>
targos pushed a commit that referenced this pull request Feb 15, 2024
@targos
fs: update jsdoc for filehandle.createWriteStream and appendFile
d8bb4b2 
PR-URL: #51494
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Deokjin Kim <deokjin81.kim@gmail.com>
marco-ippolito pushed a commit to marco-ippolito/node that referenced this pull request Feb 19, 2024
@marco-ippolito
fs: update jsdoc for filehandle.createWriteStream and appendFile
4091f71 
PR-URL: nodejs#51494
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Deokjin Kim <deokjin81.kim@gmail.com>
@marco-ippolito marco-ippolito mentioned this pull request Mar 1, 2024
Merged
richardlau pushed a commit that referenced this pull request Mar 25, 2024
@richardlau
fs: update jsdoc for filehandle.createWriteStream and appendFile
ae5ba77 
PR-URL: #51494
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Deokjin Kim <deokjin81.kim@gmail.com>
richardlau pushed a commit that referenced this pull request Mar 25, 2024
@richardlau
fs: update jsdoc for filehandle.createWriteStream and appendFile
1b7ccec 
PR-URL: #51494
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Deokjin Kim <deokjin81.kim@gmail.com>
@richardlau richardlau mentioned this pull request Mar 25, 2024
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

Assignees

No one assigned

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

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@pluris @nodejs-github-bot @lpinca @deokjinkim