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
Domain: github.com
{"@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-controller | voltron_issues_fragments |
| route-action | issue_layout |
| fetch-nonce | v2:ff8ba644-29ac-4e04-f179-a9ccaf54c160 |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | C9C6:B2172:8FE4E:C61F2:6A4C6F09 |
| html-safe-nonce | ad2662f9216fb6b961b29d12be727b9b614b75b9c2034c17783a73a55aab63e8 |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJDOUM2OkIyMTcyOjhGRTRFOkM2MUYyOjZBNEM2RjA5IiwidmlzaXRvcl9pZCI6IjIyNzcxMzU5OTkzNDY0Mzc4OTgiLCJyZWdpb25fZWRnZSI6ImlhZCIsInJlZ2lvbl9yZW5kZXIiOiJpYWQifQ== |
| visitor-hmac | c5d8e0354efe29bcb6206bd6be68132a7c69e31d038bc6fd51c245b0d1f69447 |
| hovercard-subject-tag | issue:1032459436 |
| github-keyboard-shortcuts | repository,issues,copilot |
| google-site-verification | Apib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I |
| octolytics-url | https://collector.github.com/github/collect |
| analytics-location | / |
| fb:app_id | 1401488693436528 |
| apple-itunes-app | app-id=1477376905, app-argument=https://github.com/_view_fragments/issues/show/nodejs/node/40546/issue_layout |
| twitter:image | https://opengraph.githubassets.com/4acd64c0d891419bdec8028515fce9ae7e9521fa4af91ae869cbe3b9f14bfbda/nodejs/node/issues/40546 |
| twitter:card | summary_large_image |
| og:image | https://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:width | 1200 |
| og:image:height | 600 |
| og:site_name | GitHub |
| og:type | object |
| og:author:username | n3okill |
| hostname | github.com |
| expected-hostname | github.com |
| None | 3d11bb817438277de2a940854450e83a7d32b6aeb5014e9e6b00a6423900251c |
| turbo-cache-control | no-preview |
| go-import | github.com/nodejs/node git https://github.com/nodejs/node.git |
| octolytics-dimension-user_id | 9950313 |
| octolytics-dimension-user_login | nodejs |
| octolytics-dimension-repository_id | 27193779 |
| octolytics-dimension-repository_nwo | nodejs/node |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 27193779 |
| octolytics-dimension-repository_network_root_nwo | nodejs/node |
| turbo-body-classes | logged-out env-production page-responsive |
| disable-turbo | false |
| browser-stats-url | https://api.github.com/_private/browser/stats |
| browser-errors-url | https://api.github.com/_private/browser/errors |
| release | 14099438da5379150f15a2892474c7c7e6c0e55e |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
Links:
Viewport: width=device-width