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: Remove default Node.js support #117

Merged
merged 1 commit into from
Oct 12, 2019
Merged

feat: Remove default Node.js support #117

merged 1 commit into from
Oct 12, 2019

Conversation

luczsoma
Copy link
Member

@luczsoma luczsoma commented Oct 4, 2019

BREAKING CHANGE: Default Node.js support is removed. It is hard to use
different APIs in different environments right in today's bundled world.

Closes #116.

Pull Request Checklist

Please check if your PR fulfills the following requirements:

  • The pull request consists of exactly one commit.
  • The commit message follows the commit message guidelines.
  • Tests for the changes have been added / updated (for features / bug fixes).
  • Docs have been added / updated (for features / bug fixes).

Pull Request Type

What kind of change does this pull request introduce?

  • Feature
  • Bugfix
  • Code styling update
  • Refactoring / performance improvement (no functional changes, no API changes)
  • Build related changes
  • CI related changes
  • Documentation content changes
  • Testing related changes
  • Housekeeping (e.g. dependency updates)
  • Reverting a previous change

What is the current behavior? Which issue does this PR close?

Issue reference: #116

What is the new behavior?

In Node.js environment, the module will not work, unless the user injects a Node-based entropy provider instance, which has every step written down in the README.md

Does this PR introduce a breaking change?

  • Yes
  • No

This PR contains a breaking change. If you used crypto-random is a Node.js environment, you will need to copy-paste some code from the README.md file specifically prepared for this scenario. It will take about 15 minutes.

Other information

@luczsoma luczsoma self-assigned this Oct 4, 2019
@auto-badge auto-badge bot added the feat New feature or improvement label Oct 4, 2019
@luczsoma luczsoma force-pushed the feat/no-node-js branch 3 times, most recently from 2785e66 to d301bdd Compare October 12, 2019 12:36
BREAKING CHANGE: Default Node.js support is removed. It is hard to use
different APIs in different environments right in today's bundled world.

Closes #116.
@luczsoma luczsoma merged commit abd3174 into develop Oct 12, 2019
@luczsoma luczsoma deleted the feat/no-node-js branch October 12, 2019 12:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feat New feature or improvement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Remove Node.js support
1 participant