Skip to content

doc: improve callback params for fs.mkdir#43016

Merged
nodejs-github-bot merged 2 commits intonodejs:masterfrom
daeyeon:master.fs-220509.Mon.15f0
May 22, 2022
Merged

doc: improve callback params for fs.mkdir#43016
nodejs-github-bot merged 2 commits intonodejs:masterfrom
daeyeon:master.fs-220509.Mon.15f0

Conversation

@daeyeon
Copy link
Member

@daeyeon daeyeon commented May 9, 2022

Fixes: #43015

Signed-off-by: Daeyeon Jeong daeyeon.dev@gmail.com

@daeyeon
doc: improve callback params for fs.mkdir
e59a104 
fixes: nodejs#43015

Signed-off-by: Daeyeon Jeong daeyeon.dev@gmail.com
@nodejs-github-bot nodejs-github-bot added doc Issues and PRs related to the documentations. fs Issues and PRs related to the fs subsystem / file system. labels May 9, 2022
aduh95
aduh95 reviewed May 9, 2022
View reviewed changes
doc/api/fs.md Outdated
* `mode` {string|integer} Not supported on Windows. **Default:** `0o777`.
* `callback` {Function}
* `err` {Error}
* `path` {string|undefined}
Copy link
Contributor

@aduh95 aduh95 May 9, 2022

Choose a reason for hiding this comment

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

It'd be nice to specify that that argument won't be present most of the times.

Suggested change
* `path` {string|undefined}
* `path` {string|undefined} Present only if a directory is created with `recursive` set to `true`.

Copy link
Member Author

@daeyeon daeyeon May 9, 2022

Choose a reason for hiding this comment

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

Applied the suggestion.

@daeyeon
fix: apply the specification
d741758 
Signed-off-by: Daeyeon Jeong daeyeon.dev@gmail.com
@aduh95 aduh95 added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label May 9, 2022
@aduh95 aduh95 added commit-queue Add this label to land a pull request using GitHub Actions. commit-queue-squash Add this label to instruct the Commit Queue to squash all the PR commits into the first one. labels May 22, 2022
@nodejs-github-bot nodejs-github-bot removed the commit-queue Add this label to land a pull request using GitHub Actions. label May 22, 2022
@nodejs-github-bot
Copy link
Collaborator

nodejs-github-bot commented May 22, 2022

Commit Queue failed
- Loading data for nodejs/node/pull/43016
FetchError: Invalid response body while trying to fetch https://api.github.com/graphql: Premature close
    at consumeBody (file:///opt/hostedtoolcache/node/16.15.0/x64/lib/node_modules/node-core-utils/node_modules/node-fetch/src/body.js:234:60)
    at processTicksAndRejections (node:internal/process/task_queues:96:5)
    at async Response.text (file:///opt/hostedtoolcache/node/16.15.0/x64/lib/node_modules/node-core-utils/node_modules/node-fetch/src/body.js:158:18)
    at async Request.json (file:///opt/hostedtoolcache/node/16.15.0/x64/lib/node_modules/node-core-utils/lib/request.js:51:18)
    at async Request.query (file:///opt/hostedtoolcache/node/16.15.0/x64/lib/node_modules/node-core-utils/lib/request.js:109:20)
    at async Request.queryAll (file:///opt/hostedtoolcache/node/16.15.0/x64/lib/node_modules/node-core-utils/lib/request.js:136:20)
    at async Request.gql (file:///opt/hostedtoolcache/node/16.15.0/x64/lib/node_modules/node-core-utils/lib/request.js:66:22)
    at async PRData.getComments (file:///opt/hostedtoolcache/node/16.15.0/x64/lib/node_modules/node-core-utils/lib/pr_data.js:97:21)
    at async Promise.all (index 2)
    at async Promise.all (index 1) {
  type: 'system',
  errno: 'ERR_STREAM_PREMATURE_CLOSE',
  code: 'ERR_STREAM_PREMATURE_CLOSE',
  erroredSysCall: undefined
}
https://github.com/nodejs/node/actions/runs/2366128088

@nodejs-github-bot nodejs-github-bot added the commit-queue-failed An error occurred while landing this pull request using GitHub Actions. label May 22, 2022
@aduh95 aduh95 added commit-queue Add this label to land a pull request using GitHub Actions. and removed commit-queue-failed An error occurred while landing this pull request using GitHub Actions. labels May 22, 2022
@nodejs-github-bot nodejs-github-bot removed the commit-queue Add this label to land a pull request using GitHub Actions. label May 22, 2022
@nodejs-github-bot nodejs-github-bot merged commit def4bb7 into nodejs:master May 22, 2022
@nodejs-github-bot
Copy link
Collaborator

nodejs-github-bot commented May 22, 2022

Landed in def4bb7

@daeyeon daeyeon deleted the master.fs-220509.Mon.15f0 branch May 25, 2022 03:01
bengl pushed a commit that referenced this pull request May 30, 2022
@daeyeon @bengl
doc: improve callback params for fs.mkdir
71074ee 
fixes: #43015

Signed-off-by: Daeyeon Jeong daeyeon.dev@gmail.com

PR-URL: #43016
Fixes: #43015
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Darshan Sen <raisinten@gmail.com>
Reviewed-By: Akhil Marsonya <akhil.marsonya27@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Zeyu "Alex" Yang <himself65@outlook.com>
@bengl bengl mentioned this pull request May 31, 2022
Merged
juanarbol pushed a commit that referenced this pull request May 31, 2022
@daeyeon @juanarbol
doc: improve callback params for fs.mkdir
d40733d 
fixes: #43015

Signed-off-by: Daeyeon Jeong daeyeon.dev@gmail.com

PR-URL: #43016
Fixes: #43015
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Darshan Sen <raisinten@gmail.com>
Reviewed-By: Akhil Marsonya <akhil.marsonya27@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Zeyu "Alex" Yang <himself65@outlook.com>
@juanarbol juanarbol mentioned this pull request May 31, 2022
Closed
danielleadams pushed a commit that referenced this pull request Jun 27, 2022
@daeyeon @danielleadams
doc: improve callback params for fs.mkdir
258be07 
fixes: #43015

Signed-off-by: Daeyeon Jeong daeyeon.dev@gmail.com

PR-URL: #43016
Fixes: #43015
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Darshan Sen <raisinten@gmail.com>
Reviewed-By: Akhil Marsonya <akhil.marsonya27@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Zeyu "Alex" Yang <himself65@outlook.com>
targos pushed a commit that referenced this pull request Jul 12, 2022
@daeyeon @targos
doc: improve callback params for fs.mkdir
75542d2 
fixes: #43015

Signed-off-by: Daeyeon Jeong daeyeon.dev@gmail.com

PR-URL: #43016
Fixes: #43015
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Darshan Sen <raisinten@gmail.com>
Reviewed-By: Akhil Marsonya <akhil.marsonya27@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Zeyu "Alex" Yang <himself65@outlook.com>
targos pushed a commit that referenced this pull request Jul 31, 2022
@daeyeon @targos
doc: improve callback params for fs.mkdir
c591a29 
fixes: #43015

Signed-off-by: Daeyeon Jeong daeyeon.dev@gmail.com

PR-URL: #43016
Fixes: #43015
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Darshan Sen <raisinten@gmail.com>
Reviewed-By: Akhil Marsonya <akhil.marsonya27@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Zeyu "Alex" Yang <himself65@outlook.com>
@targos targos mentioned this pull request Aug 3, 2022
Merged
guangwong pushed a commit to noslate-project/node that referenced this pull request Oct 10, 2022
@daeyeon @guangwong
doc: improve callback params for fs.mkdir
c19d612 
fixes: nodejs/node#43015

Signed-off-by: Daeyeon Jeong daeyeon.dev@gmail.com

PR-URL: nodejs/node#43016
Fixes: nodejs/node#43015
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Darshan Sen <raisinten@gmail.com>
Reviewed-By: Akhil Marsonya <akhil.marsonya27@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Zeyu "Alex" Yang <himself65@outlook.com>
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

@tniessen tniessen tniessen approved these changes

@himself65 himself65 himself65 approved these changes

@aduh95 aduh95 aduh95 approved these changes

@marsonya marsonya marsonya approved these changes

@RaisinTen RaisinTen RaisinTen 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. commit-queue-squash Add this label to instruct the Commit Queue to squash all the PR commits into the first one. doc Issues and PRs related to the documentations. fs Issues and PRs related to the fs subsystem / file system.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

fs.mkdir is inconsistent in the number of arguments passed to the callback , when completed.

8 participants

@daeyeon @nodejs-github-bot @lpinca @tniessen @himself65 @aduh95 @marsonya @RaisinTen