@restart/hooks - npm Package Compare versions

Comparing version 0.3.25 to 0.3.26

cjs/useBreakpoint.d.ts

@@ -26,3 +26,3 @@ export declare type BreakpointDirection = 'up' | 'down' | true;
 export declare function createBreakpointHook<TKey extends string>(breakpointValues: Record<TKey, string | number>): {
-    (breakpointMap: Partial<Record<TKey, BreakpointDirection>>): boolean;
+    (breakpointMap: BreakpointMap<TKey>): boolean;
     (breakpoint: TKey, direction?: true | "up" | "down" | undefined): boolean;
@@ -29,0 +29,0 @@ };

cjs/useCallbackRef.d.ts

@@ -25,2 +25,5 @@ /**
  */
-export default function useCallbackRef<TValue = unknown>(): [TValue | null, (ref: TValue | null) => void];
+export default function useCallbackRef<TValue = unknown>(): [
+    TValue | null,
+    (ref: TValue | null) => void
+];

cjs/useMap.js

@@ -16,5 +16,5 @@ "use strict";
 
-function isNativeReflectConstruct() { if (typeof Reflect === "undefined" || !Reflect.construct) return false; if (Reflect.construct.sham) return false; if (typeof Proxy === "function") return true; try { Date.prototype.toString.call(Reflect.construct(Date, [], function () {})); return true; } catch (e) { return false; } }
+function _construct(Parent, args, Class) { if (_isNativeReflectConstruct()) { _construct = Reflect.construct; } else { _construct = function _construct(Parent, args, Class) { var a = [null]; a.push.apply(a, args); var Constructor = Function.bind.apply(Parent, a); var instance = new Constructor(); if (Class) _setPrototypeOf(instance, Class.prototype); return instance; }; } return _construct.apply(null, arguments); }
 
-function _construct(Parent, args, Class) { if (isNativeReflectConstruct()) { _construct = Reflect.construct; } else { _construct = function _construct(Parent, args, Class) { var a = [null]; a.push.apply(a, args); var Constructor = Function.bind.apply(Parent, a); var instance = new Constructor(); if (Class) _setPrototypeOf(instance, Class.prototype); return instance; }; } return _construct.apply(null, arguments); }
+function _isNativeReflectConstruct() { if (typeof Reflect === "undefined" || !Reflect.construct) return false; if (Reflect.construct.sham) return false; if (typeof Proxy === "function") return true; try { Date.prototype.toString.call(Reflect.construct(Date, [], function () {})); return true; } catch (e) { return false; } }
 
@@ -27,5 +27,3 @@ function _isNativeFunction(fn) { return Function.toString.call(fn).indexOf("[native code]") !== -1; }
 
-var ObservableMap =
-/*#__PURE__*/
-function (_Map) {
+var ObservableMap = /*#__PURE__*/function (_Map) {
   _inheritsLoose(ObservableMap, _Map);
@@ -66,5 +64,3 @@
   return ObservableMap;
-}(
-/*#__PURE__*/
-_wrapNativeSuper(Map));
+}( /*#__PURE__*/_wrapNativeSuper(Map));
 /**
@@ -71,0 +67,0 @@ * Create and return a [Map](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map) that triggers rerenders when it's updated.

cjs/useMergeState.js

@@ -36,7 +36,7 @@ "use strict";
         var nextState = update(state);
-        return nextState == null ? state : _extends({}, state, {}, nextState);
+        return nextState == null ? state : _extends({}, state, nextState);
       });
     } else {
       setState(function (state) {
-        return _extends({}, state, {}, update);
+        return _extends({}, state, update);
       });
@@ -43,0 +43,0 @@ }

cjs/useSet.js

@@ -16,5 +16,5 @@ "use strict";
 
-function isNativeReflectConstruct() { if (typeof Reflect === "undefined" || !Reflect.construct) return false; if (Reflect.construct.sham) return false; if (typeof Proxy === "function") return true; try { Date.prototype.toString.call(Reflect.construct(Date, [], function () {})); return true; } catch (e) { return false; } }
+function _construct(Parent, args, Class) { if (_isNativeReflectConstruct()) { _construct = Reflect.construct; } else { _construct = function _construct(Parent, args, Class) { var a = [null]; a.push.apply(a, args); var Constructor = Function.bind.apply(Parent, a); var instance = new Constructor(); if (Class) _setPrototypeOf(instance, Class.prototype); return instance; }; } return _construct.apply(null, arguments); }
 
-function _construct(Parent, args, Class) { if (isNativeReflectConstruct()) { _construct = Reflect.construct; } else { _construct = function _construct(Parent, args, Class) { var a = [null]; a.push.apply(a, args); var Constructor = Function.bind.apply(Parent, a); var instance = new Constructor(); if (Class) _setPrototypeOf(instance, Class.prototype); return instance; }; } return _construct.apply(null, arguments); }
+function _isNativeReflectConstruct() { if (typeof Reflect === "undefined" || !Reflect.construct) return false; if (Reflect.construct.sham) return false; if (typeof Proxy === "function") return true; try { Date.prototype.toString.call(Reflect.construct(Date, [], function () {})); return true; } catch (e) { return false; } }
 
@@ -27,5 +27,3 @@ function _isNativeFunction(fn) { return Function.toString.call(fn).indexOf("[native code]") !== -1; }
 
-var ObservableSet =
-/*#__PURE__*/
-function (_Set) {
+var ObservableSet = /*#__PURE__*/function (_Set) {
   _inheritsLoose(ObservableSet, _Set);
@@ -66,5 +64,3 @@
   return ObservableSet;
-}(
-/*#__PURE__*/
-_wrapNativeSuper(Set));
+}( /*#__PURE__*/_wrapNativeSuper(Set));
 /**
@@ -71,0 +67,0 @@ * Create and return a [Set](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set) that triggers rerenders when it's updated.

cjs/useTimeout.d.ts

 /**
  * Returns a controller object for setting a timeout that is properly cleaned up
  * once the component unmounts. New timeouts cancel and replace existing ones.
+ *
+ *
+ *
+ * ```tsx
+ * const { set, clear } = useTimeout();
+ * const [hello, showHello] = useState(false);
+ * //Display hello after 5 seconds
+ * set(() => showHello(true), 5000);
+ * return (
+ *   <div className="App">
+ *     {hello ? <h3>Hello</h3> : null}
+ *   </div>
+ * );
+ * ```
  */
@@ -5,0 +19,0 @@ export default function useTimeout(): {

cjs/useTimeout.js

@@ -33,2 +33,16 @@ "use strict";
  * once the component unmounts. New timeouts cancel and replace existing ones.
+ *
+ *
+ *
+ * ```tsx
+ * const { set, clear } = useTimeout();
+ * const [hello, showHello] = useState(false);
+ * //Display hello after 5 seconds
+ * set(() => showHello(true), 5000);
+ * return (
+ *   <div className="App">
+ *     {hello ? <h3>Hello</h3> : null}
+ *   </div>
+ * );
+ * ```
  */
@@ -35,0 +49,0 @@

esm/useBreakpoint.d.ts

@@ -26,3 +26,3 @@ export declare type BreakpointDirection = 'up' | 'down' | true;
 export declare function createBreakpointHook<TKey extends string>(breakpointValues: Record<TKey, string | number>): {
-    (breakpointMap: Partial<Record<TKey, BreakpointDirection>>): boolean;
+    (breakpointMap: BreakpointMap<TKey>): boolean;
     (breakpoint: TKey, direction?: true | "up" | "down" | undefined): boolean;
@@ -29,0 +29,0 @@ };

esm/useCallbackRef.d.ts

@@ -25,2 +25,5 @@ /**
  */
-export default function useCallbackRef<TValue = unknown>(): [TValue | null, (ref: TValue | null) => void];
+export default function useCallbackRef<TValue = unknown>(): [
+    TValue | null,
+    (ref: TValue | null) => void
+];

esm/useMap.js

@@ -5,5 +5,5 @@ function _inheritsLoose(subClass, superClass) { subClass.prototype = Object.create(superClass.prototype); subClass.prototype.constructor = subClass; subClass.__proto__ = superClass; }
 
-function isNativeReflectConstruct() { if (typeof Reflect === "undefined" || !Reflect.construct) return false; if (Reflect.construct.sham) return false; if (typeof Proxy === "function") return true; try { Date.prototype.toString.call(Reflect.construct(Date, [], function () {})); return true; } catch (e) { return false; } }
+function _construct(Parent, args, Class) { if (_isNativeReflectConstruct()) { _construct = Reflect.construct; } else { _construct = function _construct(Parent, args, Class) { var a = [null]; a.push.apply(a, args); var Constructor = Function.bind.apply(Parent, a); var instance = new Constructor(); if (Class) _setPrototypeOf(instance, Class.prototype); return instance; }; } return _construct.apply(null, arguments); }
 
-function _construct(Parent, args, Class) { if (isNativeReflectConstruct()) { _construct = Reflect.construct; } else { _construct = function _construct(Parent, args, Class) { var a = [null]; a.push.apply(a, args); var Constructor = Function.bind.apply(Parent, a); var instance = new Constructor(); if (Class) _setPrototypeOf(instance, Class.prototype); return instance; }; } return _construct.apply(null, arguments); }
+function _isNativeReflectConstruct() { if (typeof Reflect === "undefined" || !Reflect.construct) return false; if (Reflect.construct.sham) return false; if (typeof Proxy === "function") return true; try { Date.prototype.toString.call(Reflect.construct(Date, [], function () {})); return true; } catch (e) { return false; } }
 
@@ -18,5 +18,3 @@ function _isNativeFunction(fn) { return Function.toString.call(fn).indexOf("[native code]") !== -1; }
 import useStableMemo from './useStableMemo';
-export var ObservableMap =
-/*#__PURE__*/
-function (_Map) {
+export var ObservableMap = /*#__PURE__*/function (_Map) {
   _inheritsLoose(ObservableMap, _Map);
@@ -57,5 +55,3 @@
   return ObservableMap;
-}(
-/*#__PURE__*/
-_wrapNativeSuper(Map));
+}( /*#__PURE__*/_wrapNativeSuper(Map));
 /**
@@ -62,0 +58,0 @@ * Create and return a [Map](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map) that triggers rerenders when it's updated.

esm/useMergeState.js

@@ -31,7 +31,7 @@ function _extends() { _extends = Object.assign || function (target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i]; for (var key in source) { if (Object.prototype.hasOwnProperty.call(source, key)) { target[key] = source[key]; } } } return target; }; return _extends.apply(this, arguments); }
         var nextState = update(state);
-        return nextState == null ? state : _extends({}, state, {}, nextState);
+        return nextState == null ? state : _extends({}, state, nextState);
       });
     } else {
       setState(function (state) {
-        return _extends({}, state, {}, update);
+        return _extends({}, state, update);
       });
@@ -38,0 +38,0 @@ }

esm/useSet.js

@@ -5,5 +5,5 @@ function _inheritsLoose(subClass, superClass) { subClass.prototype = Object.create(superClass.prototype); subClass.prototype.constructor = subClass; subClass.__proto__ = superClass; }
 
-function isNativeReflectConstruct() { if (typeof Reflect === "undefined" || !Reflect.construct) return false; if (Reflect.construct.sham) return false; if (typeof Proxy === "function") return true; try { Date.prototype.toString.call(Reflect.construct(Date, [], function () {})); return true; } catch (e) { return false; } }
+function _construct(Parent, args, Class) { if (_isNativeReflectConstruct()) { _construct = Reflect.construct; } else { _construct = function _construct(Parent, args, Class) { var a = [null]; a.push.apply(a, args); var Constructor = Function.bind.apply(Parent, a); var instance = new Constructor(); if (Class) _setPrototypeOf(instance, Class.prototype); return instance; }; } return _construct.apply(null, arguments); }
 
-function _construct(Parent, args, Class) { if (isNativeReflectConstruct()) { _construct = Reflect.construct; } else { _construct = function _construct(Parent, args, Class) { var a = [null]; a.push.apply(a, args); var Constructor = Function.bind.apply(Parent, a); var instance = new Constructor(); if (Class) _setPrototypeOf(instance, Class.prototype); return instance; }; } return _construct.apply(null, arguments); }
+function _isNativeReflectConstruct() { if (typeof Reflect === "undefined" || !Reflect.construct) return false; if (Reflect.construct.sham) return false; if (typeof Proxy === "function") return true; try { Date.prototype.toString.call(Reflect.construct(Date, [], function () {})); return true; } catch (e) { return false; } }
 
@@ -18,5 +18,3 @@ function _isNativeFunction(fn) { return Function.toString.call(fn).indexOf("[native code]") !== -1; }
 import useStableMemo from './useStableMemo';
-export var ObservableSet =
-/*#__PURE__*/
-function (_Set) {
+export var ObservableSet = /*#__PURE__*/function (_Set) {
   _inheritsLoose(ObservableSet, _Set);
@@ -57,5 +55,3 @@
   return ObservableSet;
-}(
-/*#__PURE__*/
-_wrapNativeSuper(Set));
+}( /*#__PURE__*/_wrapNativeSuper(Set));
 /**
@@ -62,0 +58,0 @@ * Create and return a [Set](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set) that triggers rerenders when it's updated.

esm/useTimeout.d.ts

 /**
  * Returns a controller object for setting a timeout that is properly cleaned up
  * once the component unmounts. New timeouts cancel and replace existing ones.
+ *
+ *
+ *
+ * ```tsx
+ * const { set, clear } = useTimeout();
+ * const [hello, showHello] = useState(false);
+ * //Display hello after 5 seconds
+ * set(() => showHello(true), 5000);
+ * return (
+ *   <div className="App">
+ *     {hello ? <h3>Hello</h3> : null}
+ *   </div>
+ * );
+ * ```
  */
@@ -5,0 +19,0 @@ export default function useTimeout(): {

esm/useTimeout.js

@@ -24,2 +24,16 @@ import { useMemo, useRef } from 'react';
  * once the component unmounts. New timeouts cancel and replace existing ones.
+ *
+ *
+ *
+ * ```tsx
+ * const { set, clear } = useTimeout();
+ * const [hello, showHello] = useState(false);
+ * //Display hello after 5 seconds
+ * set(() => showHello(true), 5000);
+ * return (
+ *   <div className="App">
+ *     {hello ? <h3>Hello</h3> : null}
+ *   </div>
+ * );
+ * ```
  */
@@ -26,0 +40,0 @@

package.json

 {
   "name": "@restart/hooks",
-  "version": "0.3.25",
+  "version": "0.3.26",
   "main": "cjs/index.js",
@@ -40,10 +40,8 @@ "types": "cjs/index.d.ts",
   "peerDependencies": {
-    "react": "^16.8.0"
+    "react": ">=16.8.0"
   },
   "dependencies": {
-    "lodash": "^4.17.15",
-    "lodash-es": "^4.17.15"
-  },
-  "readme": "ERROR: No README data found!",
-  "_id": "@restart/hooks@0.3.21"
+    "lodash": "^4.17.20",
+    "lodash-es": "^4.17.20"
+  }
 }

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

166837

increased by0.61%

Lines of code

4517

increased by1.03%

Dependency changes

• + Addedreact@18.3.1(transitive)

• - Removedobject-assign@4.1.1(transitive)

• - Removedprop-types@15.8.1(transitive)

• - Removedreact@16.14.0(transitive)

• - Removedreact-is@16.13.1(transitive)

• Updatedlodash@^4.17.20

• Updatedlodash-es@^4.17.20