-
Notifications
You must be signed in to change notification settings - Fork 566
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
docs: File class is not explicitly documented #1799
Comments
I think they are sufficiently documented by e.g. MDN? Why duplicate it? |
IMO at the very least we should document that they exist in undici and link to MDN. Wdyt? The main issue in the above comment is that they didn't know File was an undici export because it isn't documented anywhere. |
Yeah, just documenting that they exists as exports from |
Hey, I want to try doing this if it is just a documentation task. |
Yes it is! Just linking to MDN would be fine. |
Could you please help me by pointing to where exactly in the documentation I need to add a link to the MDN documentation and also the MDN documentation link? @mcollina @ThisIsMissEm |
You would need to create a new Fetch.md file https://github.com/nodejs/undici/tree/main/docs/api and update the sidebar https://github.com/nodejs/undici/blob/main/docsify/sidebar.md
|
So the Fetch.md file would be something like
And after this, I would need to add the link to the Fetch.d file I just created in the sidebar.md file right? @KhafraDev |
@VedanthB you might want to do a subheading for each, with the text "This API is implemented as per the standard, you can find documentation on the [Mozilla Developer Network].”, given each of them are classes that can be instantiated. |
I have raised a PR, please review it. |
Originally posted by @ThisIsMissEm in nodejs/node#45763 (comment)
In general, the documentation around fetch could massively be improved. We don't seem to document Headers, Request, Response, FormData, or File.
The text was updated successfully, but these errors were encountered: