Fixing errors with CommonJS import of ws
#108
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
kellydunn
changed the title
ws.ws
dmonad
reviewed
Aug 19, 2022
| @@ -5,6 +5,7 @@ | |||
| "main": "./dist/y-websocket.cjs", | |||
| "module": "./src/y-websocket.js", | |||
| "types": "./dist/src/y-websocket.d.ts", | |||
| "type": "module", | |||
There was a problem hiding this comment.
Currently, we can't make this change because it would break others using this package.
| const wsProvider = new WebsocketProvider('ws://localhost:1234', 'my-roomname', doc, { WebSocketPolyfill: require('ws') }) | ||
| import ws from 'ws'; | ||
|
|
||
| const wsProvider = new WebsocketProvider('ws://localhost:1234', 'my-roomname', doc, { WebSocketPolyfill: ws }) |
There was a problem hiding this comment.
It really depends on your bundler whether you need to use the commons version require or the esm version import.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Hello there!
When attempting to get a Hello World of
y-websocketworking as a client running nodev17.8.0, I encountered a few errors regarding missing imports forwsinsrc/y-websocket.js. This PR includes the following to get a fully functioning Hello World moving from the client's perspective:WebSocketexplicitly fromwspackage.jsonto explicitly call out this as an ES module (similar PRs: Set type as ES Module #104)README.mdfor updated boilerplateHuly®: YJS-754