René's URL Explorer Experiment


Title: doc: fs.ReadStream and fs.WriteStream public/private clarification · Issue #40546 · nodejs/node · GitHub

Open Graph Title: doc: fs.ReadStream and fs.WriteStream public/private clarification · Issue #40546 · nodejs/node

X Title: doc: fs.ReadStream and fs.WriteStream public/private clarification · Issue #40546 · nodejs/node

Description: 📗 API Reference Docs Problem Version: since v0.10x Platform: all Subsystem: fs Location Section of the site where the content exists Affected URL(s): https://nodejs.org/dist/latest-v14.x/docs/api/fs.html#fs_class_fs_readstream https://no...

Open Graph Description: 📗 API Reference Docs Problem Version: since v0.10x Platform: all Subsystem: fs Location Section of the site where the content exists Affected URL(s): https://nodejs.org/dist/latest-v14.x/docs/api/f...

X Description: 📗 API Reference Docs Problem Version: since v0.10x Platform: all Subsystem: fs Location Section of the site where the content exists Affected URL(s): https://nodejs.org/dist/latest-v14.x/docs/api/f...

Opengraph URL: https://github.com/nodejs/node/issues/40546

X: @github

direct link

Domain: github.com


Hey, it has json ld scripts:
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"doc: fs.ReadStream and fs.WriteStream public/private clarification","articleBody":"# 📗 API Reference Docs Problem\r\n\r\n\u003c!--\r\n\r\nThank you for wanting to make nodejs.org better!\r\n\r\nThis template is for issues with the Node.js API\r\nreference documentation.\r\n\r\nFor problems with nodejs.org beyond the API\r\nreference documentation, please open an issue\r\nusing the issue tracker for our site repository.\r\n\r\n  https://github.com/nodejs/nodejs.org\r\n\r\nFor more general support, please open an issue\r\nusing the issue tracker for our help repository.\r\n\r\n  https://github.com/nodejs/help\r\n\r\n---\r\n\r\nFor the issue title, please enter a one-line\r\nsummary after “doc: ” (preferably 50 characters\r\nor less and no more than 72).\r\n\r\nThe “✍️” are placeholders signifying requests for\r\ninput. Replace them with your responses.\r\n\r\nIf you are unsure of something, do your best.\r\n\r\n--\u003e\r\n\r\n\u003c!-- The output of “node --version”. --\u003e\r\n\r\n- **Version**: since v0.10x\r\n\r\n\u003c!-- The output of “uname -a” (UNIX) or version\r\nand 32-bit or 64-bit (Windows). --\u003e\r\n\r\n- **Platform**: all\r\n\r\n\u003c!-- The name of affected core module. --\u003e\r\n\r\n- **Subsystem**: fs\r\n\r\n## Location\r\n\r\n_Section of the site where the content exists_\r\n\r\nAffected URL(s):\r\n\r\n- https://nodejs.org/dist/latest-v14.x/docs/api/fs.html#fs_class_fs_readstream\r\n- https://nodejs.org/dist/latest-v14.x/docs/api/fs.html#fs_class_fs_writestream\r\n\r\n## Description\r\n\r\nI know the `fs.createReadSteam` and `fs.createWriteStream` are the way to go to create streams in the fs module, but i've seen in many examples in the internet people using `new fs.ReadStream` and `new fs.WriteStream`, I believe it would be good to have a clarification in the docs if `fs.ReadStream` and `fs.WriteStream` are considered public and making `new fs.ReadStream` or extendig it, for example, should be considered 'legal' or if otherwise this should be private and we should never use `new fs.ReadStream` or `new fs.WriteStream`.\r\n\r\n\u003c!-- If applicable, include any screenshots that\r\nmay help solve the problem. --\u003e\r\n\r\n✍️\r\n\r\n---\r\n\r\n\u003c!-- Use “[x]” to check the box below if you are\r\ninterested in contributing. --\u003e\r\n\r\n- [ ] I would like to work on this issue and\r\n      submit a pull request.\r\n","author":{"url":"https://github.com/n3okill","@type":"Person","name":"n3okill"},"datePublished":"2021-10-21T12:53:23.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":0},"url":"https://github.com/40546/node/issues/40546"}

route-pattern/_view_fragments/issues/show/:user_id/:repository/:id/issue_layout(.:format)
route-controllervoltron_issues_fragments
route-actionissue_layout
fetch-noncev2:ff8ba644-29ac-4e04-f179-a9ccaf54c160
current-catalog-service-hash81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114
request-idC9C6:B2172:8FE4E:C61F2:6A4C6F09
html-safe-noncead2662f9216fb6b961b29d12be727b9b614b75b9c2034c17783a73a55aab63e8
visitor-payloadeyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJDOUM2OkIyMTcyOjhGRTRFOkM2MUYyOjZBNEM2RjA5IiwidmlzaXRvcl9pZCI6IjIyNzcxMzU5OTkzNDY0Mzc4OTgiLCJyZWdpb25fZWRnZSI6ImlhZCIsInJlZ2lvbl9yZW5kZXIiOiJpYWQifQ==
visitor-hmacc5d8e0354efe29bcb6206bd6be68132a7c69e31d038bc6fd51c245b0d1f69447
hovercard-subject-tagissue:1032459436
github-keyboard-shortcutsrepository,issues,copilot
google-site-verificationApib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I
octolytics-urlhttps://collector.github.com/github/collect
analytics-location///voltron/issues_fragments/issue_layout
fb:app_id1401488693436528
apple-itunes-appapp-id=1477376905, app-argument=https://github.com/_view_fragments/issues/show/nodejs/node/40546/issue_layout
twitter:imagehttps://opengraph.githubassets.com/4acd64c0d891419bdec8028515fce9ae7e9521fa4af91ae869cbe3b9f14bfbda/nodejs/node/issues/40546
twitter:cardsummary_large_image
og:imagehttps://opengraph.githubassets.com/4acd64c0d891419bdec8028515fce9ae7e9521fa4af91ae869cbe3b9f14bfbda/nodejs/node/issues/40546
og:image:alt📗 API Reference Docs Problem Version: since v0.10x Platform: all Subsystem: fs Location Section of the site where the content exists Affected URL(s): https://nodejs.org/dist/latest-v14.x/docs/api/f...
og:image:width1200
og:image:height600
og:site_nameGitHub
og:typeobject
og:author:usernamen3okill
hostnamegithub.com
expected-hostnamegithub.com
None3d11bb817438277de2a940854450e83a7d32b6aeb5014e9e6b00a6423900251c
turbo-cache-controlno-preview
go-importgithub.com/nodejs/node git https://github.com/nodejs/node.git
octolytics-dimension-user_id9950313
octolytics-dimension-user_loginnodejs
octolytics-dimension-repository_id27193779
octolytics-dimension-repository_nwonodejs/node
octolytics-dimension-repository_publictrue
octolytics-dimension-repository_is_forkfalse
octolytics-dimension-repository_network_root_id27193779
octolytics-dimension-repository_network_root_nwonodejs/node
turbo-body-classeslogged-out env-production page-responsive
disable-turbofalse
browser-stats-urlhttps://api.github.com/_private/browser/stats
browser-errors-urlhttps://api.github.com/_private/browser/errors
release14099438da5379150f15a2892474c7c7e6c0e55e
ui-targetfull
theme-color#1e2327
color-schemelight dark

Links:

Skip to contenthttps://github.com/nodejs/node/issues/40546#start-of-content
https://github.com/
Sign in https://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fnodejs%2Fnode%2Fissues%2F40546
GitHub CopilotWrite better code with AIhttps://github.com/features/copilot
GitHub Copilot appDirect agents from issue to mergehttps://github.com/features/ai/github-app
MCP RegistryNewIntegrate external toolshttps://github.com/mcp
ActionsAutomate any workflowhttps://github.com/features/actions
CodespacesInstant dev environmentshttps://github.com/features/codespaces
IssuesPlan and track workhttps://github.com/features/issues
Code ReviewManage code changeshttps://github.com/features/code-review
GitHub Advanced SecurityFind and fix vulnerabilitieshttps://github.com/security/advanced-security
Code securitySecure your code as you buildhttps://github.com/security/advanced-security/code-security
Secret protectionStop leaks before they starthttps://github.com/security/advanced-security/secret-protection
Why GitHubhttps://github.com/why-github
Documentationhttps://docs.github.com
Bloghttps://github.blog
Changeloghttps://github.blog/changelog
Marketplacehttps://github.com/marketplace
View all featureshttps://github.com/features
Enterpriseshttps://github.com/enterprise
Small and medium teamshttps://github.com/team
Startupshttps://github.com/enterprise/startups
Nonprofitshttps://github.com/solutions/industry/nonprofits
App Modernizationhttps://github.com/solutions/use-case/app-modernization
DevSecOpshttps://github.com/solutions/use-case/devsecops
DevOpshttps://github.com/solutions/use-case/devops
CI/CDhttps://github.com/solutions/use-case/ci-cd
View all use caseshttps://github.com/solutions/use-case
Healthcarehttps://github.com/solutions/industry/healthcare
Financial serviceshttps://github.com/solutions/industry/financial-services
Manufacturinghttps://github.com/solutions/industry/manufacturing
Governmenthttps://github.com/solutions/industry/government
View all industrieshttps://github.com/solutions/industry
View all solutionshttps://github.com/solutions
AIhttps://github.com/resources/articles?topic=ai
Software Developmenthttps://github.com/resources/articles?topic=software-development
DevOpshttps://github.com/resources/articles?topic=devops
Securityhttps://github.com/resources/articles?topic=security
View all topicshttps://github.com/resources/articles
Customer storieshttps://github.com/customer-stories
Events & webinarshttps://github.com/resources/events
Ebooks & reportshttps://github.com/resources/whitepapers
Business insightshttps://github.com/solutions/executive-insights
GitHub Skillshttps://skills.github.com
Documentationhttps://docs.github.com
Customer supporthttps://support.github.com
Community forumhttps://github.com/orgs/community/discussions
Trust centerhttps://github.com/trust-center
Partnershttps://github.com/partners
View all resourceshttps://github.com/resources
GitHub SponsorsFund open source developershttps://github.com/sponsors
Security Labhttps://securitylab.github.com
Maintainer Communityhttps://maintainers.github.com
Acceleratorhttps://github.com/accelerator
GitHub Starshttps://stars.github.com
Archive Programhttps://archiveprogram.github.com
Topicshttps://github.com/topics
Trendinghttps://github.com/trending
Collectionshttps://github.com/collections
Enterprise platformAI-powered developer platformhttps://github.com/enterprise
GitHub Advanced SecurityEnterprise-grade security featureshttps://github.com/security/advanced-security
Copilot for BusinessEnterprise-grade AI featureshttps://github.com/features/copilot/copilot-business
Premium SupportEnterprise-grade 24/7 supporthttps://github.com/premium-support
Pricinghttps://github.com/pricing
Search syntax tipshttps://docs.github.com/search-github/github-code-search/understanding-github-code-search-syntax
documentationhttps://docs.github.com/search-github/github-code-search/understanding-github-code-search-syntax
Sign in https://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fnodejs%2Fnode%2Fissues%2F40546
Sign up https://github.com/signup?ref_cta=Sign+up&ref_loc=header+logged+out&ref_page=%2F%3Cuser-name%3E%2F%3Crepo-name%3E%2Fvoltron%2Fissues_fragments%2Fissue_layout&source=header-repo&source_repo=nodejs%2Fnode
Reloadhttps://github.com/nodejs/node/issues/40546
Reloadhttps://github.com/nodejs/node/issues/40546
Reloadhttps://github.com/nodejs/node/issues/40546
Please reload this pagehttps://github.com/nodejs/node/issues/40546
nodejs https://github.com/nodejs
nodehttps://github.com/nodejs/node
Please reload this pagehttps://github.com/nodejs/node/issues/40546
Notifications https://github.com/login?return_to=%2Fnodejs%2Fnode
Fork 36k https://github.com/login?return_to=%2Fnodejs%2Fnode
Star 118k https://github.com/login?return_to=%2Fnodejs%2Fnode
Code https://github.com/nodejs/node
Issues 1.4k https://github.com/nodejs/node/issues
Pull requests 964 https://github.com/nodejs/node/pulls
Actions https://github.com/nodejs/node/actions
Projects https://github.com/nodejs/node/projects
Security and quality 0 https://github.com/nodejs/node/security
Insights https://github.com/nodejs/node/pulse
Code https://github.com/nodejs/node
Issues https://github.com/nodejs/node/issues
Pull requests https://github.com/nodejs/node/pulls
Actions https://github.com/nodejs/node/actions
Projects https://github.com/nodejs/node/projects
Security and quality https://github.com/nodejs/node/security
Insights https://github.com/nodejs/node/pulse
#62208https://github.com/nodejs/node/pull/62208
doc: fs.ReadStream and fs.WriteStream public/private clarificationhttps://github.com/nodejs/node/issues/40546#top
#62208https://github.com/nodejs/node/pull/62208
docIssues and PRs related to the documentations.https://github.com/nodejs/node/issues?q=state%3Aopen%20label%3A%22doc%22
fsIssues and PRs related to the fs subsystem / file system.https://github.com/nodejs/node/issues?q=state%3Aopen%20label%3A%22fs%22
https://github.com/n3okill
n3okillhttps://github.com/n3okill
on Oct 21, 2021https://github.com/nodejs/node/issues/40546#issue-1032459436
https://nodejs.org/dist/latest-v14.x/docs/api/fs.html#fs_class_fs_readstreamhttps://nodejs.org/dist/latest-v14.x/docs/api/fs.html#fs_class_fs_readstream
https://nodejs.org/dist/latest-v14.x/docs/api/fs.html#fs_class_fs_writestreamhttps://nodejs.org/dist/latest-v14.x/docs/api/fs.html#fs_class_fs_writestream
docIssues and PRs related to the documentations.https://github.com/nodejs/node/issues?q=state%3Aopen%20label%3A%22doc%22
fsIssues and PRs related to the fs subsystem / file system.https://github.com/nodejs/node/issues?q=state%3Aopen%20label%3A%22fs%22
https://github.com
Termshttps://docs.github.com/site-policy/github-terms/github-terms-of-service
Privacyhttps://docs.github.com/site-policy/privacy-policies/github-privacy-statement
Securityhttps://github.com/security
Statushttps://www.githubstatus.com/
Communityhttps://github.community/
Docshttps://docs.github.com/
Contacthttps://support.github.com?tags=dotcom-footer

Viewport: width=device-width


URLs of crawlers that visited me.