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.

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

v3 upgrade Docs needs to be updated #1216

Closed
jimmywarting opened this issue Jul 20, 2021 · 0 comments · Fixed by #1236
Closed

v3 upgrade Docs needs to be updated #1216

jimmywarting opened this issue Jul 20, 2021 · 0 comments · Fixed by #1236

Comments

@jimmywarting
Copy link
Collaborator

jimmywarting commented Jul 20, 2021

## Minimum supported Node.js version is now 10.16

I'm not a native english speaker
So I would like it if someone who is better than me in english updates the document to say that we require node v12.20 now (cuz of ESM #1141)

I also think there needs to be a upgrade guide on how to import node-fetch now when it's a ESM only package from a cjs package.
one way to load it from cjs is via the async import() another way if you do not want to convert you entire project into esm would be to just add a wrapper and load cjs files from a esm file (ref: #1127 (comment))

We do not have to push a new minor patch. Since there is no api changes

Maybe should say something more about this in the main README file under https://github.com/node-fetch/node-fetch#loading-and-configuring-the-module

Who wants to tackle this API documentation?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant