MTS/yjs-backend
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

add docs for url parameters

Browse Source
This commit is contained in:
Kevin Jahns 2024-05-09 20:00:34 +02:00
parent d8f1e6b0e1
commit ce95ba870f
1 changed files with 5 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -82,7 +82,7 @@ import { WebsocketProvider } from 'y-websocket'
wsOpts = { wsOpts = {
// Set this to `false` if you want to connect manually using wsProvider.connect() // Set this to `false` if you want to connect manually using wsProvider.connect()
connect: true, connect: true,
// Specify a query-string that will be url-encoded and attached to the `serverUrl` // Specify a query-string / url parameters that will be url-encoded and attached to the `serverUrl`
// I.e. params = { auth: "bearer" } will be transformed to "?auth=bearer" // I.e. params = { auth: "bearer" } will be transformed to "?auth=bearer"
params: {}, // Object<string,string> params: {}, // Object<string,string>
// You may polyill the Websocket object (https://developer.mozilla.org/en-US/docs/Web/API/WebSocket). // You may polyill the Websocket object (https://developer.mozilla.org/en-US/docs/Web/API/WebSocket).
@ -106,6 +106,10 @@ wsOpts = {
<dd>True if this instance is currently communicating to other browser-windows via BroadcastChannel.</dd> <dd>True if this instance is currently communicating to other browser-windows via BroadcastChannel.</dd>
<b><code>wsProvider.synced: boolean</code></b> <b><code>wsProvider.synced: boolean</code></b>
<dd>True if this instance is currently connected and synced with the server.</dd> <dd>True if this instance is currently connected and synced with the server.</dd>
<b><code>wsProvider.params : boolean</code></b>
<dd>The specified url parameters. This can be safely updated, the new values
will be used when a new connction is established. If this contains an
auth token, it should be updated regularly.</dd>
<b><code>wsProvider.disconnect()</code></b> <b><code>wsProvider.disconnect()</code></b>
<dd>Disconnect from the server and don't try to reconnect.</dd> <dd>Disconnect from the server and don't try to reconnect.</dd>
<b><code>wsProvider.connect()</code></b> <b><code>wsProvider.connect()</code></b>