useController() takes configuration options (#1179)

- options object makes it more discoverable and explicit what is being
set while allowing for potential future options
- add action creators
  - createInvalidate
  - createReset

BREAKING CHANGE: useController(true) -> useController({ throttle: true
})

Author: ntucker

packages/experimental/src/createInvalidate.ts

@@ -0,0 +1,15 @@
+import { actionTypes } from '@rest-hooks/core';
+import type { EndpointInterface } from '@rest-hooks/endpoint';
+import type { InvalidateAction } from '@rest-hooks/core';
+
+export default function createInvalidate<E extends EndpointInterface>(
+  endpoint: E,
+  { args }: { args: readonly [...Parameters<E>] },
+): InvalidateAction {
+  return {
+    type: actionTypes.INVALIDATE_TYPE,
+    meta: {
+      key: endpoint.key(...args),
+    },
+  };
+}

packages/experimental/src/createReset.ts

@@ -0,0 +1,9 @@
+import { actionTypes } from '@rest-hooks/core';
+import type { ResetAction } from '@rest-hooks/core';
+
+export default function createReset(): ResetAction {
+  return {
+    type: actionTypes.RESET_TYPE,
+    date: new Date(),
+  };
+}

packages/experimental/src/index.ts

@@ -2,6 +2,8 @@ export { default as useFetcher } from './useFetcher';
 export { default as useController } from './useController';
 export type { Controller } from './useController';
 export { default as createFetch } from './createFetch';
+export { default as createInvalidate } from './createFetch';
+export { default as createReset } from './createFetch';
 export { default as Resource } from './rest/Resource';
 export { default as BaseResource } from './rest/BaseResource';
 import { schema, Entity } from '@rest-hooks/endpoint';

packages/experimental/src/useController.ts

@@ -1,16 +1,21 @@
 import { EndpointInterface } from '@rest-hooks/endpoint';
 import { DispatchContext } from '@rest-hooks/core';
 import { useContext, useCallback } from 'react';
-import { actionTypes } from '@rest-hooks/core';
 
 import createFetch from './createFetch';
+import createInvalidate from './createInvalidate';
+import createReset from './createReset';
 import { UpdateFunction } from './types';
 
 /**
  * Imperative control of Rest Hooks store
  * @see https://resthooks.io/docs/api/useController
  */
-export default function useController(throttle = false): Controller {
+export default function useController({
+  throttle = false,
+}: {
+  throttle?: boolean;
+} = {}): Controller {
   const dispatch = useContext(DispatchContext);
 
   // TODO: elevate into CacheProvider and simply useContext
@@ -36,22 +41,17 @@ export default function useController(throttle = false): Controller {
       ...args: readonly [...Parameters<E>] | readonly [null]
     ) =>
       args[0] !== null
-        ? dispatch({
-            type: actionTypes.INVALIDATE_TYPE,
-            meta: {
-              key: endpoint.key(...args),
-            },
-          })
+        ? dispatch(
+            createInvalidate(endpoint, {
+              args: args as readonly [...Parameters<E>],
+            }),
+          )
         : Promise.resolve(),
     [dispatch],
   );
 
   const resetEntireStore = useCallback(
-    () =>
-      dispatch({
-        type: actionTypes.RESET_TYPE,
-        date: new Date(),
-      }),
+    () => dispatch(createReset()),
     [dispatch],
   );
 

packages/experimental/src/useFetcher.ts

@@ -13,5 +13,5 @@ export default function useFetcher(
   endpoint: E,
   ...args: readonly [...Parameters<E>]
 ) => ReturnType<E> {
-  return useController(throttle).fetch;
+  return useController({ throttle }).fetch;
 }