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

feat: add warning for when node polyfill is used in non-node environments #90

Merged
merged 3 commits into from
Aug 22, 2023

Conversation

pi0
Copy link
Member

@pi0 pi0 commented Aug 22, 2023

πŸ”— Linked issue

❓ Type of change

  • πŸ“– Documentation (updates to the documentation, readme, or JSdoc annotations)
  • 🐞 Bug fix (a non-breaking change that fixes an issue)
  • πŸ‘Œ Enhancement (improving an existing functionality like performance)
  • ✨ New feature (a non-breaking change that adds functionality)
  • 🧹 Chore (updates to the build process or auxiliary tools and libraries)
  • ⚠️ Breaking change (fix or feature that would cause existing functionality to change)

πŸ“š Description

node-fetch-native is intended to be used with proper export conditions otherwise a build with node-fetch polyfills will be used in non-Node.js environments like workers and can be silently happening too.

This PR adds an explicit warning to guide users:

Node.js compatible build of node-fetch-native is being used in a non-Node.js environment. Please make sure you are using proper export conditions or report this issue to https://github.com/unjs/node-fetch-native. You can set process.env.DISABLE_NODE_FETCH_NATIVE_WARN to disable this warning.

πŸ“ Checklist

  • I have linked an issue or discussion.
  • I have updated the documentation accordingly.

@pi0 pi0 requested a review from danielroe August 22, 2023 11:44
@pi0 pi0 merged commit a04969a into main Aug 22, 2023
1 check passed
@pi0 pi0 deleted the feat/non-node-warn branch August 22, 2023 11:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants