@cloudflare/realtimekit-react 0.0.0 → 2.5.0-staging.88

package/dist/index.d.ts

@@ -0,0 +1,56 @@
+import RTKClient, { RealtimeKitClientOptions } from '@cloudflare/realtimekit';
+export { RTKBasicParticipant, RTKConnectedMeetings, RTKParticipant, RTKParticipantMap, RTKParticipants, RTKPermissionsPreset, RTKPlugin, RTKSelf, RTKSelfMedia, RTKThemePreset } from '@cloudflare/realtimekit';
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import React, { ReactNode } from 'react';
+
+type Listener = () => void;
+declare class RTKUpdates {
+    private meeting;
+    private l;
+    constructor(meeting: RTKClient);
+    clean(): void;
+    addListener(listener: Listener): void;
+    removeListener(listener: Listener): void;
+    private onUpdate;
+}
+declare const RealtimeKitContext: React.Context<{
+    meeting: DyteClient | undefined;
+    updates: RTKUpdates | undefined;
+}>;
+/**
+ * Provider component which makes the RealtimeKit meeting object
+ * available to nested components
+ * @component
+ * @param value The RealtimeKitClient instance from `useRealtimeKitClient()`
+ * @param fallback Any fallback UI you want to render until the instance initialises.
+ */
+declare function RealtimeKitProvider({ value, children, fallback, }: {
+    value: RTKClient | undefined;
+    children: ReactNode;
+    fallback?: ReactNode;
+}): react_jsx_runtime.JSX.Element;
+/**
+ * Hook which returns the reference to the RealtimeKit meeting object
+ * @returns meeting instance
+ */
+declare const useRealtimeKitMeeting: () => {
+    meeting: any;
+};
+
+interface DyteClientParams {
+    resetOnLeave?: boolean;
+}
+
+/**
+ * Hook to get and intialise an instance of RealtimeKit meeting object
+ */
+declare const useRealtimeKitClient: (dyteClientParams?: DyteClientParams) => readonly [RTKClient | undefined, (options: RealtimeKitClientOptions) => Promise<RTKClient | undefined>];
+type StateSelector<T extends object, U> = (state: T) => U;
+/**
+ * Hook which extracts data from the RealtimeKit meeting object and re-renders on change.
+ * @param selector The selector function which takes the meeting object and returns a slice of state
+ * @returns The slice of state returned by the selector function
+ */
+declare const useRealtimeKitSelector: <StateSlice>(selector: StateSelector<RTKClient, StateSlice>) => StateSlice;
+
+export { RealtimeKitContext, RealtimeKitProvider, useRealtimeKitClient, useRealtimeKitMeeting, useRealtimeKitSelector };