设置
HocuspocusProvider
| 设置 | 描述 | 默认值 |
|---|
url | Hocuspocus/WebSocket 服务器的 URL。 | '' |
websocketProvider | HocuspocusProviderWebsocket 的一个实例,如果你想在多个提供者之间共享一个 socket。 | new HocuspocusProviderWebsocket() |
name | 文档的名称。 | '' |
document | 实际的 Y.js 文档。可选,默认会创建一个新文档,并可通过 provider.document 访问。 | new Y.Doc() |
token | 将传递给服务器的身份验证令牌(支持字符串、函数和 Promises)。 | '' |
awareness | Awareness 对象,默认会附加到传入的 Y.js 文档上。 | new Awareness() |
forceSyncInterval | 每隔 x 毫秒向服务器请求更新。 | false |
sessionAwareness | 在每条消息的文档名中嵌入唯一的 sessionId,从而允许在同一个 WebSocket 上使用多个具有相同文档名的提供者。连接到 v3 服务器时请保持为 false。需要 v4 服务器。 | false |
HocuspocusProviderWebsocket
| 设置 | 描述 | 默认值 |
|---|
url | Hocuspocus/WebSocket 服务器的 URL。 | '' |
WebSocketPolyfill | 在 Node.js 环境中运行时:传入 WebSocket 的 polyfill,例如 ws。 | WebSocket |
timeout | 毫秒为单位的超时时间。如果超时非零,则设置一个 setTimeout 定时器触发。如果触发超时,后续尝试将终止。 | 0 |
factor | 用于以指数方式增长延迟的因子选项。 | 2 |
maxAttempts | 最大尝试次数,若为 0,则尝试次数无上限。 | 0 |
minDelay | 当抖动(jitter)启用时,用于设置延迟的下限。如果关闭抖动,则此属性无效。 | 1000 |
maxDelay | 用于设置当启用因子调整时的延迟上限。如果不需要上限,可设置为 0。 | 30000 |
jitter | 若为 true,则当前迭代的延迟将在 minDelay 与计算得出的延迟之间随机取整数值。 | true |
messageReconnectTimeout | 如果在配置的 messageReconnectTimeout 时间内未收到消息,则关闭连接。 | 30000 |
delay | 每次尝试之间的延迟时间(毫秒)。可传入因子以实现延迟指数增长。 | 1000 |
initialDelay | 首次尝试前的等待时间。该选项通常为 0,因为通常希望首次尝试立即进行。 | 0 |
使用
配置提供者不需要过多步骤,一个简单示例可见于 快速入门