mercuryworkshop-mirror/bare-mux
1
0
Fork 0
mirror of https://github.com/MercuryWorkshop/bare-mux.git synced 2025-05-17 08:00:01 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update Upgrading.md

Browse source
This commit is contained in:
Percs 2024-07-27 04:30:54 -05:00 • committed by GitHub
parent a5f551c08d
commit ffb7a6ef48
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 4 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

7
documentation/Upgrading.md
View file

@ -18,12 +18,12 @@ app.use("/baremux/", express.static(baremuxPath));
The newest version of bare-mux uses [SharedWorkers](https://developer.mozilla.org/en-US/docs/Web/API/SharedWorker). To initialize bare-mux we have to start a connection. The connection takes the worker path in as a required argument that is needed to proceed with the connection. The
```js
import { BareMuxConnection } from "@mercuryworkshop/bare-mux"
let connection = new BareMuxConnection("/baremux/worker.js")
const connection = new BareMuxConnection("/baremux/worker.js")
```
Without using a bundler:
```js
let connection = new BareMux.BareMuxConnection("/baremux/worker.js")
const connection = new BareMux.BareMuxConnection("/baremux/worker.js")
```
### Setting the transport
@ -36,5 +36,6 @@ await connection.setTransport("/baremod/index.mjs", ["https://tomp.app/"]);
It is recommended to keep your proxy page in an IFrame of the page with the initialized connection, as sometimes the service worker loses connection and needs to contact the page to get a `MessagePort` back. If your enviroment is not setup like this, it may cause issues.
Your transport should get set before the service worker is ready, otherwise this may cause a race condition and the transport may not be used for some requests.
If you are moving from bare-mux v1, you can remove your imports of the transports in the page and service worker as bare-mux v2 streamlines the experience to where imports are loaded inside of the SharedWorker. The only time where bare-mux needs to be imported now is when you are making the connection with `BareMuxConnection`.