hakowork/charm
3
0
Fork 0
mirror of https://github.com/littensy/charm.git synced 2026-10-23 05:46:27 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: add client/server tags

Browse source
This commit is contained in:
Richard 2024-06-11 16:53:48 -07:00
parent ebcffe6996
commit 939edc645a
1 changed files with 2 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

2
src/index.d.ts vendored
View file

@ -196,6 +196,7 @@ declare namespace Charm {
* Creates a `ClientSyncer` object that receives patches from the server and * Creates a `ClientSyncer` object that receives patches from the server and
* applies them to the local state. * applies them to the local state.
* *
* @client
* @param options The atoms to synchronize with the server. * @param options The atoms to synchronize with the server.
* @returns A `ClientSyncer` object. * @returns A `ClientSyncer` object.
*/ */
@ -204,6 +205,7 @@ declare namespace Charm {
* Creates a `ServerSyncer` object that sends patches to the client and * Creates a `ServerSyncer` object that sends patches to the client and
* hydrates the client's state. * hydrates the client's state.
* *
* @server
* @param options The atoms to synchronize with the client. * @param options The atoms to synchronize with the client.
* @returns A `ServerSyncer` object. * @returns A `ServerSyncer` object.
*/ */