-
Notifications
You must be signed in to change notification settings - Fork 30.1k
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.
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
doc,fs: document WHATWG URL support #12341
Comments
I'm happy to help as a mentor on this for those that pick it up. |
If that can wait until saturday i would love to give it a try as a first contribution. You guys deserve all of our freetime as support. I wanted to start contributing to node since some time now. That seems to be a good first step |
@anchnk sorry just saw this. Feel free to dm me on twitter for specific questions on getting started |
For that point, I am curious what would be the recommended way to handle this ? I see two options :
I would like to stay in line, maybe it's something you already sort in the past. |
@anchnk I'd prefer it stated once, much like the existing Buffer API section. |
@TimothyGu Thank you for your feedback ! I should put a note mentioning the restriction at the root level of the module's description then ? |
That would work. I tend to prefer the documentation closer to the actual methods to keep users from having to jump around through the document to find all the bits they need. But, reducing duplication is a good thing also, and as @TimothyGu points out, there is plenty of precedence. A note with the restriction at the root level sounds just fine. |
Update fs module documentation adding WHATWG file URLS support for relevant fs functions/classes. Fixes: nodejs#12341 Refs: nodejs#10739
Update fs module documentation adding WHATWG file URLS support for relevant fs functions/classes. Fixes: nodejs#12341 Refs: nodejs#10739
#10739 (fs: allow WHATWG URL and file: URLs as paths) was landed without documentation, because
url.URL
itself was undocumented at that time. Nowurl.URL
is documented here, so thefs
docs should include its support, too.I think this is about what needs to be done:
URL
needs to be added to the lists of supported types for the filename parametersfile:///
URL objects are supportedchanges:
lists for the relevant methods that states the version this was added in (7.6.0) and that the support is currently still experimental.As always, let us know here, in #node-dev on Freenode, or basically anywhere where you can reach us if you need any help or have any questions!
(oh, also: please comment here if you would like to try and take this on, so people don’t get in each other’s way. 😸 )
The text was updated successfully, but these errors were encountered: