use-undoable - npm Package Compare versions

Comparing version 3.3.2 to 3.3.3

dist/errors.d.ts

 declare const payloadError: (func: string) => never;
-export { payloadError };
+declare const invalidBehavior: (behavior: string) => never;
+export { payloadError, invalidBehavior, };

dist/index.js

@@ -25,2 +25,6 @@ var react = require('react');
 
+var invalidBehavior = function invalidBehavior(behavior) {
+  throw new Error("Mutation behavior must be one of: mergePastReversed, mergePast, keepFuture, or destroyFuture. Not: " + behavior);
+};
+
 var ensureLimit = function ensureLimit(limit, arr) {
@@ -90,2 +94,3 @@ if (!limit) return arr;
   };
+  if (!behaviorMap.hasOwnProperty(behavior)) invalidBehavior(behavior);
   return behaviorMap[behavior];
@@ -92,0 +97,0 @@ };

dist/index.modern.js

@@ -25,2 +25,6 @@ import { useReducer, useCallback } from 'react';
 
+var invalidBehavior = function invalidBehavior(behavior) {
+  throw new Error("Mutation behavior must be one of: mergePastReversed, mergePast, keepFuture, or destroyFuture. Not: " + behavior);
+};
+
 var ensureLimit = function ensureLimit(limit, arr) {
@@ -90,2 +94,3 @@ if (!limit) return arr;
   };
+  if (!behaviorMap.hasOwnProperty(behavior)) invalidBehavior(behavior);
   return behaviorMap[behavior];
@@ -92,0 +97,0 @@ };

package.json

 {
   "name": "use-undoable",
-  "version": "3.3.2",
+  "version": "3.3.3",
   "description": "React hook for undo/redo functionality without the hassle.",
@@ -5,0 +5,0 @@ "private": false,

README.md

@@ -127,3 +127,3 @@ # useUndoable
 
-Defines the max size for the history. The default is `100.` The resulting `past` array will be +1 whatever number you give. That is, if you set the `historyLimit` to 5, there will actually be 6 total items within the array because the `present` is merged into it on every state change.
+Defines the max size for the history. The default is `100`. The resulting `past` array will be +1 whatever number you give. That is, if you set the `historyLimit` to 5, there will actually be 6 total items within the array because the `present` is merged into it on every state change.
 
@@ -404,2 +404,4 @@ Therefore, if your project absolutely requires there to be only 1,000 **total** items, for example, set the limit to `999`.
 
+One more note: This function **does not** reset the _actual_ state you passed into the hook itself (`useUndoable([])`); it only changes the item at index `0` in the `past` array.
+
 ## Performance considerations
@@ -406,0 +408,0 @@

No alert changes

Improved metrics

Total package byte prevSize

57395

3.34%

Lines of code

480

1.91%

Number of lines in readme file

462

0.43%

No dependency changes