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.

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

doc: add fspromises mkdir example #40843

Merged
merged 8 commits into from
Jun 12, 2022
Merged

doc: add fspromises mkdir example #40843

merged 8 commits into from
Jun 12, 2022

Conversation

bnb
Copy link
Contributor

@bnb bnb commented Nov 17, 2021

Adds an example to the fsPromises mkdir doc. Includes both cjs and mjs versions, because we should support both imo.

@bnb
doc: add fspromises mkdir example
7a4a320 
Signed-off-by: Tierney Cyren <hello@bnb.im>
@duckduckstab1

This comment has been minimized.

Sign in to view
VoltrexKeyva
VoltrexKeyva reviewed Nov 17, 2021
View reviewed changes
doc/api/fs.md Outdated Show resolved Hide resolved
doc/api/fs.md Outdated Show resolved Hide resolved
@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 Nov 17, 2021
@bnb
doc: fspromises mkdir example cleanup
9fcb48e 
Signed-off-by: Tierney Cyren <hello@bnb.im>
@aduh95 aduh95 added 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. labels Nov 19, 2021
jasnell
jasnell reviewed Nov 20, 2021
View reviewed changes
doc/api/fs.md Outdated Show resolved Hide resolved
@Trott Trott removed the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Dec 12, 2021
bnb
bnb commented Dec 13, 2021
View reviewed changes
doc/api/fs.md Outdated Show resolved Hide resolved
@bnb
doc: update fs mkdir examples for clarity
38ed2f2 
Signed-off-by: Tierney Cyren <hello@bnb.im>
@bnb
Copy link
Contributor Author

bnb commented Jun 11, 2022

@aduh95 PTAL. Should be good now. Worth noting that I also added a slash at the end of the CJS example, again to be consistent.

@bnb bnb added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Jun 11, 2022
@bnb
Copy link
Contributor Author

bnb commented Jun 11, 2022

Added author ready PRs that have at least one approval, no pending requests for changes, and a CI started. back 👍🏻

@bnb
Copy link
Contributor Author

bnb commented Jun 11, 2022

(also apologies for the delay, ngl I forgot this was open)

aduh95
aduh95 requested changes Jun 11, 2022
View reviewed changes
Copy link
Contributor

@aduh95 aduh95 left a comment

Choose a reason for hiding this comment

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

All the docs are now using node: prefix.

doc/api/fs.md Outdated Show resolved Hide resolved
doc/api/fs.md Outdated Show resolved Hide resolved
aduh95
aduh95 reviewed Jun 11, 2022
View reviewed changes
doc/api/fs.md Outdated Show resolved Hide resolved
aduh95
aduh95 reviewed Jun 11, 2022
View reviewed changes
doc/api/fs.md Outdated

}

makeDirectory();
Copy link
Contributor

@aduh95 aduh95 Jun 11, 2022 •
edited
Loading

Choose a reason for hiding this comment

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

nit: instead of a try/catch, I would put a .catch(console.error): calling an async function without awaiting it or having a catch handler should be frowned upon imho.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

would you want me to move the MJS example to be a function and do the same, or should that continue using top-level await in a try/catch?

bnb added 5 commits June 11, 2022 16:44
@bnb
doc: use node prefix in fs/promises mkdir examples
90e60a2 
Signed-off-by: Tierney Cyren <hello@bnb.im>
@bnb
doc: make fs/promises mkdir cjs example work
d63bc20 
Signed-off-by: Tierney Cyren <hello@bnb.im>
@bnb
doc: remove try/catch in fs/promises mkdir example
f0c22f3 
Signed-off-by: Tierney Cyren <hello@bnb.im>
@bnb
doc: use prefix in esm fs/promises mkdir example
7bc43d8 
Signed-off-by: Tierney Cyren <hello@bnb.im>
@bnb
doc: add missing semicolon in fs.md
775fb38 
Signed-off-by: Tierney Cyren <hello@bnb.im>
@aduh95 aduh95 added the commit-queue Add this label to land a pull request using GitHub Actions. label Jun 12, 2022
@nodejs-github-bot nodejs-github-bot removed the commit-queue Add this label to land a pull request using GitHub Actions. label Jun 12, 2022
@nodejs-github-bot nodejs-github-bot merged commit fab676e into nodejs:master Jun 12, 2022
@nodejs-github-bot
Copy link
Collaborator

Landed in fab676e

italojs pushed a commit to italojs/node that referenced this pull request Jun 12, 2022
@bnb @italojs
doc: add fspromises mkdir example
f54a984 
Signed-off-by: Tierney Cyren <hello@bnb.im>

PR-URL: nodejs#40843
Reviewed-By: Adrian Estrada <edsadr@gmail.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Mohammed Keyvanzadeh <mohammadkeyvanzade94@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
danielleadams pushed a commit that referenced this pull request Jun 13, 2022
@bnb @danielleadams
doc: add fspromises mkdir example
f0c0faf 
Signed-off-by: Tierney Cyren <hello@bnb.im>

PR-URL: #40843
Reviewed-By: Adrian Estrada <edsadr@gmail.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Mohammed Keyvanzadeh <mohammadkeyvanzade94@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
@danielleadams danielleadams mentioned this pull request Jun 13, 2022
Merged
danielleadams pushed a commit that referenced this pull request Jun 13, 2022
@bnb @danielleadams
doc: add fspromises mkdir example
e30d4c1 
Signed-off-by: Tierney Cyren <hello@bnb.im>

PR-URL: #40843
Reviewed-By: Adrian Estrada <edsadr@gmail.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Mohammed Keyvanzadeh <mohammadkeyvanzade94@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
@bnb bnb deleted the bnb/fspromises-mkdir branch June 14, 2022 18:04
targos pushed a commit that referenced this pull request Jul 12, 2022
@bnb @targos
doc: add fspromises mkdir example
85dfc07 
Signed-off-by: Tierney Cyren <hello@bnb.im>

PR-URL: #40843
Reviewed-By: Adrian Estrada <edsadr@gmail.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Mohammed Keyvanzadeh <mohammadkeyvanzade94@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
targos pushed a commit that referenced this pull request Jul 31, 2022
@bnb @targos
doc: add fspromises mkdir example
18c6d17 
Signed-off-by: Tierney Cyren <hello@bnb.im>

PR-URL: #40843
Reviewed-By: Adrian Estrada <edsadr@gmail.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Mohammed Keyvanzadeh <mohammadkeyvanzade94@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.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
@bnb @guangwong
doc: add fspromises mkdir example
af20152 
Signed-off-by: Tierney Cyren <hello@bnb.im>

PR-URL: nodejs/node#40843
Reviewed-By: Adrian Estrada <edsadr@gmail.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Mohammed Keyvanzadeh <mohammadkeyvanzade94@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Trott Trott Trott left review comments

@GeoffreyBooth GeoffreyBooth GeoffreyBooth left review comments

@VoltrexKeyva VoltrexKeyva VoltrexKeyva approved these changes

@aduh95 aduh95 aduh95 approved these changes

@edsadr edsadr edsadr approved these changes

@jasnell jasnell jasnell 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.
9 participants
@bnb @duckduckstab1 @nodejs-github-bot @jasnell @GeoffreyBooth @Trott @edsadr @aduh95 @VoltrexKeyva