@yorkie-js/react 0.6.5 → 0.6.6

package/dist/yorkie-js-react.d.ts

@@ -3,6 +3,7 @@ import { Indexable } from '@yorkie-js/sdk';
 import { JSONArray } from '@yorkie-js/sdk';
 import { JSONObject } from '@yorkie-js/sdk';
 import { JSX } from 'react/jsx-dev-runtime';
+import { Presence } from '@yorkie-js/sdk';
 import { PropsWithChildren } from 'react';
 import { StreamConnectionStatus } from '@yorkie-js/sdk';
 
@@ -38,7 +39,7 @@ export declare const useDocument: <R, P extends Indexable = Indexable>() => {
         presence: P;
     }[];
     connection: StreamConnectionStatus;
-    update: (callback: (root: R, presence: P) => void) => void;
+    update: (callback: (root: R, presence: Presence<P>) => void) => void;
     loading: boolean;
     error: Error | undefined;
 };
@@ -60,18 +61,25 @@ export declare const useRoot: () => {
 };
 
 /**
- * `useYorkieDoc` is a custom hook that initializes a Yorkie client and attaches a document.
+ * `useYorkieDoc` is a custom hook that initializes a Yorkie Client and a
+ * document in a single hook.
  *
  * @param apiKey
  * @param docKey
- * @param initialRoot
  * @returns
  */
-export declare function useYorkieDoc<T>(apiKey: string, docKey: string, initialRoot: T, options?: {
+export declare function useYorkieDoc<R, P extends Indexable>(apiKey: string, docKey: string, options?: {
+    initialRoot?: R;
+    initialPresence?: P;
     rpcAddr?: string;
 }): {
-    root: T;
-    update: (callback: (root: T) => void) => void;
+    root: R;
+    presences: Array<{
+        clientID: string;
+        presence: P;
+    }>;
+    connection: StreamConnectionStatus;
+    update: (callback: (root: R, presence: Presence<P>) => void) => void;
     loading: boolean;
     error: Error | undefined;
 };