Skip to content

Commit

Permalink
docs(docs): add note about .connect()
Browse files Browse the repository at this point in the history
TimoBechtel committed Jul 13, 2023

Verified

This commit was signed with the committer’s verified signature.
TimoBechtel Timo Bechtel
1 parent 339d190 commit 7ced869
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions apps/docs/docs/guide/client.md
Original file line number Diff line number Diff line change
@@ -48,6 +48,10 @@ Connects to the server. `url` is optional and defaults to the domain & port the
db.connect('ws://localhost:8080');
```

:::note Side note
You do not need to wait for the connection to finish before updating any data. SocketDB will handle this for you. Just make sure to call `connect` once before you try to update any data.
:::

## get

`get: (path: string) => ChainReference;`

0 comments on commit 7ced869

Please sign in to comment.