Consistent return signature, useRef for subscription

Author: rijk

packages/react-mongo/react-mongo.ts

@@ -1,20 +1,28 @@
 import { Meteor } from 'meteor/meteor'
 import { Mongo } from 'meteor/mongo'
 import { Tracker } from 'meteor/tracker'
-import { useEffect, useMemo, useReducer, useState, DependencyList } from 'react'
+import {
+  useEffect,
+  useMemo,
+  useReducer,
+  useRef,
+  useCallback,
+  DependencyList,
+} from 'react'
 
 const fur = (x: number): number => x + 1
 const useForceUpdate = () => useReducer(fur, 0)[1]
 
 const useSubscriptionClient = (
   name: string | false,
   args: any[]
-): void | Meteor.SubscriptionHandle => {
-  const [subscription, setSubscription] = useState<Meteor.SubscriptionHandle>()
+) => {
+  const subscription = useRef<Meteor.SubscriptionHandle>()
 
   useEffect(() => {
     if (!name) {
-      return setSubscription( null )
+      subscription.current = null
+      return
     }
 
     // Use Tracker.nonreactive in case we are inside a Tracker Computation.
@@ -24,14 +32,19 @@ const useSubscriptionClient = (
     // it stops the inner one.
     const computation = Tracker.nonreactive(() => (
       Tracker.autorun(() => {
-        setSubscription( Meteor.subscribe( name, ...args ) )
+        subscription.current = Meteor.subscribe( name, ...args )
       })
     ))
 
     return () => computation.stop()
   }, [name, ...args])
 
-  return subscription
+  return useCallback(
+    () => {
+      return subscription.current?.ready()
+    },
+    [name, ...args]
+  )
 }
 
 const useSubscriptionServer = (): Meteor.SubscriptionHandle => ({

packages/react-mongo/types/react-mongo.d.ts

@@ -1,10 +1,9 @@
-import { Meteor } from 'meteor/meteor';
 import { Mongo } from 'meteor/mongo';
 import { DependencyList } from 'react';
 declare type UseSubscriptionOptions = {
     deps?: DependencyList;
     updateOnReady?: boolean;
 };
-export declare const useSubscription: (factory: () => Meteor.SubscriptionHandle | void, deps?: DependencyList | UseSubscriptionOptions) => void;
+export declare const useSubscription: (name: string | false, args: any[]) => () => boolean;
 export declare const useCursor: <T = any>(factory: () => Mongo.Cursor<T>, deps?: DependencyList) => Mongo.Cursor<T>;
 export {};