Skip to content

docs: mention requirement to call attach() when passing websocketProvider instead of url #1006

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.

Sign up for GitHub

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

Open
roschlau wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: mention requirement to call attach() when passing websocketProvider instead of url #1006

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/provider/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,3 +38,7 @@ tableOfContents: true
## Usage

There is not much required to set up the provider, a simple example can be found in [Getting started](/getting-started#frontend)

### Sharing a websocket between providers

You can share a `HocuspocusProviderWebsocket` instance between several `HocuspocusProviders` by passing `websocketProvider` instead of `url` when configuring the provider. If you do that, you need to call `.attach()` manually on the provider once you want it to attach and start syncing.