@yorkie-js/react 0.7.9 → 0.7.10-rc

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

@@ -137,7 +137,8 @@ export { Tree }
  * `useChannel` is a custom hook that returns the channel state.
  * It must be used within a ChannelProvider.
  *
- * @returns An object containing sessionCount, loading, and error state
+ * @returns An object containing sessionCount, loading, error state and
+ *          a `detach` function for permanently stopping the channel.
  *
  * @example
  * ```tsx
@@ -155,6 +156,7 @@ export declare const useChannel: () => {
     sessionCount: number;
     loading: boolean;
     error: Error | undefined;
+    detach: () => Promise<void>;
 };
 
 /**
@@ -331,6 +333,21 @@ export declare function useYorkieDoc<R, P extends Indexable = Indexable>(apiKey:
  * `YorkieProvider` is a component that provides the Yorkie client to its children.
  * It initializes the Yorkie client with the given API key and RPC address.
  */
-export declare const YorkieProvider: React.FC<PropsWithChildren<ClientOptions>>;
+export declare const YorkieProvider: React.FC<PropsWithChildren<YorkieProviderProps>>;
+
+/**
+ * `YorkieProviderProps` extends `ClientOptions` with provider-level options.
+ *
+ * - `activate` (default `true`): whether to call `client.activate()` on mount
+ *   and `client.deactivate()` on unmount. Set to `false` for apps that only
+ *   use Channels — under the RefreshChannel-only lifecycle the SDK
+ *   lazy-attaches the client on the first heartbeat, so explicit activate
+ *   round trips become unnecessary. Document use cases (`useDocument`,
+ *   `useYorkieDoc`) still require activation, so leave this `true` if any
+ *   descendant attaches a document.
+ */
+declare type YorkieProviderProps = ClientOptions & {
+    activate?: boolean;
+};
 
 export { }