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(node): export full node crypto exports #121

Merged
merged 2 commits into from
Aug 2, 2023
Merged

Conversation

pi0
Copy link
Member

@pi0 pi0 commented Aug 2, 2023

πŸ”— Linked issue

Resolves #91

Related PR: #111

❓ 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

This PR adds all missing exports for node crypto shims to make sure it is compliant with Node.js types.

New methods are not implemented and will call an explicit runtime error if attempted to be called.

Note: Implementing the methods while possible, is not practical! A tree-shaked bundled version of browserify utils take ~550kb while with unenv with target modern runtimes (browser and workers) that all support crypto subtle. And new environments such as cloudflare workers and deno, offer their own runtime support for Node.js APIs.

Still (on a case by case basis) if there is a popular Node.js lib that needs some of them and there is a zero dep minimal implementation of some of them possible (optionally depending on web crypto and subtle crypto) it is more than welcome!

πŸ“ Checklist

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

@pi0 pi0 merged commit 37ea959 into main Aug 2, 2023
@pi0 pi0 deleted the feat/crypto-node-exports branch August 4, 2023 21:33
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.

Complete node specific crypto polyfills
1 participant