Remove type variable from PrimitiveDep.

Author: StevenXL

.github/workflows/ci.yml

@@ -15,5 +15,6 @@ jobs:
           cache: yarn
       - run: yarn install
       - run: yarn build
+      - run: yarn gen-flow
       - run: yarn test
       - run: yarn run check-git-clean

dist/index.js

@@ -3,18 +3,6 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-Object.defineProperty(exports, "idExtraDep", {
-  enumerable: true,
-  get: function get() {
-    return _useExtraDeps.idExtraDep;
-  }
-});
-Object.defineProperty(exports, "isEqualExtraDep", {
-  enumerable: true,
-  get: function get() {
-    return _useExtraDeps.isEqualExtraDep;
-  }
-});
 Object.defineProperty(exports, "unCallbackFn", {
   enumerable: true,
   get: function get() {

dist/index.js.flow

@@ -1,7 +1,7 @@
+// @flow
+
 export {
   unCallbackFn,
   unsafeMkCallbackFn,
   useExtraDeps,
-  idExtraDep,
-  isEqualExtraDep,
 } from "./use-extra-deps";

dist/use-extra-deps/index.js

@@ -7,7 +7,7 @@ var _typeof = require("@babel/runtime/helpers/typeof");
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.unCallbackFn = exports.isEqualExtraDep = exports.idExtraDep = void 0;
+exports.unCallbackFn = void 0;
 exports.unsafeMkCallbackFn = unsafeMkCallbackFn;
 exports.useExtraDeps = useExtraDeps;
 
@@ -50,18 +50,18 @@ function unsafeMkCallbackFn(f) {
   return f;
 }
 
-// Hook used to help avoid pitfalls surrounding misuse of objects and arrays in the deps of
-// `useEffect` et. al.
+// Hook used to help avoid pitfalls surrounding misuse of objects and arrays in
+// the deps of `useEffect` et. al.
 //
-// By only allowing `PrimitiveDep`s in the `deps` array and forcing functions and non-primitives
-// through `extraDeps`, we can ensure that we are not doing naive reference equality like React
-// does for the `deps` array.
+// By only allowing `PrimitiveDep`s in the `deps` array and forcing functions
+// and non-primitives through `extraDeps`, we can ensure that we are not doing
+// naive reference equality like React does for the `deps` array.
 //
 // See `useSafeEffect` for usage of this hook
 //
-// Returns an object based upon deps and extraDeps:
-// { allDeps: An array that is suitable to use as a deps array for things like `useEffect`
-// , extraDepValues: An object that has the same keys as extraDeps but contains their plain values
+// Returns an object based upon deps and extraDeps: { allDeps: An array that is
+// suitable to use as a deps array for things like `useEffect` , extraDepValues:
+// An object that has the same keys as extraDeps but contains their plain values
 // }
 //
 function useExtraDeps(deps, extraDeps) {
@@ -100,26 +100,4 @@ function useExtraDeps(deps, extraDeps) {
       return value;
     })), fns)
   };
-}
-
-var idExtraDep = function idExtraDep(value) {
-  return {
-    value: value,
-    comparator: function comparator(a, b) {
-      return a.id === b.id;
-    }
-  };
-};
-
-exports.idExtraDep = idExtraDep;
-
-var isEqualExtraDep = function isEqualExtraDep(value) {
-  return {
-    value: value,
-    comparator: function comparator(a, b) {
-      return (0, _isEqual["default"])(a, b);
-    }
-  };
-};
-
-exports.isEqualExtraDep = isEqualExtraDep;
+}

dist/use-extra-deps/index.js.flow

@@ -8,18 +8,11 @@ import mapValues from "lodash/mapValues";
 import values from "lodash/values";
 import isEqual from "lodash/isEqual";
 
-export type PrimitiveLangDep = boolean | string | number | null | void | symbol;
-
 // Dependencies that are safe to use in the normal `useEffect` deps array
-//
-// `PrimitiveDep` is a generic type. Typically usage is to bind the type
-// variable `PrimitiveDomainDep` to opaque types that wrap primitives.
-export type PrimitiveDep<PrimitiveDomainDep> =
-  | PrimitiveLangDep
-  | PrimitiveDomainDep;
+export type PrimitiveDep = boolean | string | number | null | void | symbol;
 
-// Wrapper around a function that has been wrapped in `useSafeCallback`. This type is here to avoid
-// cyclical dependencies.
+// Wrapper around a function that has been wrapped in `useSafeCallback`. This
+// type is here to avoid cyclical dependencies.
 export opaque type CallbackFn<F> = F;
 
 export const unCallbackFn = <F>(fn: CallbackFn<F>): F => fn;
@@ -35,22 +28,22 @@ export type ExtraDeps<V> =
   | {| value: V, comparator: (a: V, b: V) => boolean |}
   | CallbackFn<V>;
 
-// Hook used to help avoid pitfalls surrounding misuse of objects and arrays in the deps of
-// `useEffect` et. al.
+// Hook used to help avoid pitfalls surrounding misuse of objects and arrays in
+// the deps of `useEffect` et. al.
 //
-// By only allowing `PrimitiveDep`s in the `deps` array and forcing functions and non-primitives
-// through `extraDeps`, we can ensure that we are not doing naive reference equality like React
-// does for the `deps` array.
+// By only allowing `PrimitiveDep`s in the `deps` array and forcing functions
+// and non-primitives through `extraDeps`, we can ensure that we are not doing
+// naive reference equality like React does for the `deps` array.
 //
 // See `useSafeEffect` for usage of this hook
 //
-// Returns an object based upon deps and extraDeps:
-// { allDeps: An array that is suitable to use as a deps array for things like `useEffect`
-// , extraDepValues: An object that has the same keys as extraDeps but contains their plain values
+// Returns an object based upon deps and extraDeps: { allDeps: An array that is
+// suitable to use as a deps array for things like `useEffect` , extraDepValues:
+// An object that has the same keys as extraDeps but contains their plain values
 // }
 //
-export function useExtraDeps<S: { [key: string]: any }, PrimitiveDomainDep>(
-  deps: $ReadOnlyArray<PrimitiveDep<PrimitiveDomainDep>>,
+export function useExtraDeps<S: { [key: string]: any }>(
+  deps: $ReadOnlyArray<PrimitiveDep>,
   extraDeps: S
 ): {|
   allDeps: $ReadOnlyArray<any>,
@@ -86,13 +79,3 @@ export function useExtraDeps<S: { [key: string]: any }, PrimitiveDomainDep>(
     extraDepValues: { ...mapValues(nonFns, ({ value }) => value), ...fns },
   };
 }
-
-export const idExtraDep = <V: { id: string }>(value: V): ExtraDeps<V> => ({
-  value,
-  comparator: (a, b) => a.id === b.id,
-});
-
-export const isEqualExtraDep = <V>(value: V): ExtraDeps<V> => ({
-  value,
-  comparator: (a: V, b: V): boolean => isEqual(a, b),
-});

src/index.js

@@ -1,7 +1,7 @@
+// @flow
+
 export {
   unCallbackFn,
   unsafeMkCallbackFn,
   useExtraDeps,
-  idExtraDep,
-  isEqualExtraDep,
 } from "./use-extra-deps";

src/use-extra-deps/index.js

@@ -8,18 +8,11 @@ import mapValues from "lodash/mapValues";
 import values from "lodash/values";
 import isEqual from "lodash/isEqual";
 
-export type PrimitiveLangDep = boolean | string | number | null | void | symbol;
-
 // Dependencies that are safe to use in the normal `useEffect` deps array
-//
-// `PrimitiveDep` is a generic type. Typically usage is to bind the type
-// variable `PrimitiveDomainDep` to opaque types that wrap primitives.
-export type PrimitiveDep<PrimitiveDomainDep> =
-  | PrimitiveLangDep
-  | PrimitiveDomainDep;
+export type PrimitiveDep = boolean | string | number | null | void | symbol;
 
-// Wrapper around a function that has been wrapped in `useSafeCallback`. This type is here to avoid
-// cyclical dependencies.
+// Wrapper around a function that has been wrapped in `useSafeCallback`. This
+// type is here to avoid cyclical dependencies.
 export opaque type CallbackFn<F> = F;
 
 export const unCallbackFn = <F>(fn: CallbackFn<F>): F => fn;
@@ -35,22 +28,22 @@ export type ExtraDeps<V> =
   | {| value: V, comparator: (a: V, b: V) => boolean |}
   | CallbackFn<V>;
 
-// Hook used to help avoid pitfalls surrounding misuse of objects and arrays in the deps of
-// `useEffect` et. al.
+// Hook used to help avoid pitfalls surrounding misuse of objects and arrays in
+// the deps of `useEffect` et. al.
 //
-// By only allowing `PrimitiveDep`s in the `deps` array and forcing functions and non-primitives
-// through `extraDeps`, we can ensure that we are not doing naive reference equality like React
-// does for the `deps` array.
+// By only allowing `PrimitiveDep`s in the `deps` array and forcing functions
+// and non-primitives through `extraDeps`, we can ensure that we are not doing
+// naive reference equality like React does for the `deps` array.
 //
 // See `useSafeEffect` for usage of this hook
 //
-// Returns an object based upon deps and extraDeps:
-// { allDeps: An array that is suitable to use as a deps array for things like `useEffect`
-// , extraDepValues: An object that has the same keys as extraDeps but contains their plain values
+// Returns an object based upon deps and extraDeps: { allDeps: An array that is
+// suitable to use as a deps array for things like `useEffect` , extraDepValues:
+// An object that has the same keys as extraDeps but contains their plain values
 // }
 //
-export function useExtraDeps<S: { [key: string]: any }, PrimitiveDomainDep>(
-  deps: $ReadOnlyArray<PrimitiveDep<PrimitiveDomainDep>>,
+export function useExtraDeps<S: { [key: string]: any }>(
+  deps: $ReadOnlyArray<PrimitiveDep>,
   extraDeps: S
 ): {|
   allDeps: $ReadOnlyArray<any>,
@@ -86,13 +79,3 @@ export function useExtraDeps<S: { [key: string]: any }, PrimitiveDomainDep>(
     extraDepValues: { ...mapValues(nonFns, ({ value }) => value), ...fns },
   };
 }
-
-export const idExtraDep = <V: { id: string }>(value: V): ExtraDeps<V> => ({
-  value,
-  comparator: (a, b) => a.id === b.id,
-});
-
-export const isEqualExtraDep = <V>(value: V): ExtraDeps<V> => ({
-  value,
-  comparator: (a: V, b: V): boolean => isEqual(a, b),
-});