immutable 5.0.0-beta.4 → 5.0.0-rc.1

package/dist/immutable.js

@@ -1,4 +1,5 @@
 /**
+ * @license
  * MIT License
  * 
  * Copyright (c) 2014-present, Lee Byron and other contributors.
@@ -25,8 +26,9 @@
   typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports) :
   typeof define === 'function' && define.amd ? define(['exports'], factory) :
   (global = typeof globalThis !== 'undefined' ? globalThis : global || self, factory(global.Immutable = {}));
-}(this, (function (exports) { 'use strict';
+})(this, (function (exports) { 'use strict';
 
+  // Used for setting prototype methods that IE8 chokes on.
   var DELETE = 'delete';
 
   // Constants describing the size of trie nodes.
@@ -118,6 +120,7 @@
     return value < 0 || (value === 0 && 1 / value === -Infinity);
   }
 
+  // Note: value is unchanged to not break immutable-devtools.
   var IS_COLLECTION_SYMBOL = '@@__IMMUTABLE_ITERABLE__@@';
 
   function isCollection(maybeCollection) {
@@ -141,11 +144,13 @@
   }
 
   var Collection = function Collection(value) {
+    // eslint-disable-next-line no-constructor-return
     return isCollection(value) ? value : Seq(value);
   };
 
   var KeyedCollection = /*@__PURE__*/(function (Collection) {
     function KeyedCollection(value) {
+      // eslint-disable-next-line no-constructor-return
       return isKeyed(value) ? value : KeyedSeq(value);
     }
 
@@ -158,6 +163,7 @@
 
   var IndexedCollection = /*@__PURE__*/(function (Collection) {
     function IndexedCollection(value) {
+      // eslint-disable-next-line no-constructor-return
       return isIndexed(value) ? value : IndexedSeq(value);
     }
 
@@ -170,6 +176,7 @@
 
   var SetCollection = /*@__PURE__*/(function (Collection) {
     function SetCollection(value) {
+      // eslint-disable-next-line no-constructor-return
       return isCollection(value) && !isAssociative(value) ? value : SetSeq(value);
     }
 
@@ -310,6 +317,7 @@
 
   var Seq = /*@__PURE__*/(function (Collection) {
     function Seq(value) {
+      // eslint-disable-next-line no-constructor-return
       return value === undefined || value === null
         ? emptySequence()
         : isImmutable(value)
@@ -378,6 +386,7 @@
 
   var KeyedSeq = /*@__PURE__*/(function (Seq) {
     function KeyedSeq(value) {
+      // eslint-disable-next-line no-constructor-return
       return value === undefined || value === null
         ? emptySequence().toKeyedSeq()
         : isCollection(value)
@@ -402,6 +411,7 @@
 
   var IndexedSeq = /*@__PURE__*/(function (Seq) {
     function IndexedSeq(value) {
+      // eslint-disable-next-line no-constructor-return
       return value === undefined || value === null
         ? emptySequence()
         : isCollection(value)
@@ -434,6 +444,7 @@
 
   var SetSeq = /*@__PURE__*/(function (Seq) {
     function SetSeq(value) {
+      // eslint-disable-next-line no-constructor-return
       return (
         isCollection(value) && !isAssociative(value) ? value : IndexedSeq(value)
       ).toSetSeq();
@@ -1435,16 +1446,16 @@
       return collection;
     }
 
-    var resolvedBegin = resolveBegin(begin, originalSize);
-    var resolvedEnd = resolveEnd(end, originalSize);
-
-    // begin or end will be NaN if they were provided as negative numbers and
+    // begin or end can not be resolved if they were provided as negative numbers and
     // this collection's size is unknown. In that case, cache first so there is
     // a known size and these do not resolve to NaN.
-    if (resolvedBegin !== resolvedBegin || resolvedEnd !== resolvedEnd) {
+    if (typeof originalSize === 'undefined' && (begin < 0 || end < 0)) {
       return sliceFactory(collection.toSeq().cacheResult(), begin, end, useKeys);
     }
 
+    var resolvedBegin = resolveBegin(begin, originalSize);
+    var resolvedEnd = resolveEnd(end, originalSize);
+
     // Note: resolvedEnd is undefined when the original sequence's length is
     // unknown and this slice did not supply an end and should contain all
     // elements after resolvedBegin.
@@ -1935,6 +1946,7 @@
     return a > b ? 1 : a < b ? -1 : 0;
   }
 
+  // http://jsperf.com/copy-array-inline
   function arrCopy(arr, offset) {
     offset = offset || 0;
     var len = Math.max(0, arr.length - offset);
@@ -2006,6 +2018,9 @@
     );
   }
 
+  /**
+   * Converts a value to a string, adding quotes if a string was provided.
+   */
   function quoteString(value) {
     try {
       return typeof value === 'string' ? JSON.stringify(value) : String(value);
@@ -2382,6 +2397,7 @@
 
   var Map = /*@__PURE__*/(function (KeyedCollection) {
     function Map(value) {
+      // eslint-disable-next-line no-constructor-return
       return value === undefined || value === null
         ? emptyMap()
         : isMap(value) && !isOrdered(value)
@@ -2397,20 +2413,6 @@
     Map.prototype = Object.create( KeyedCollection && KeyedCollection.prototype );
     Map.prototype.constructor = Map;
 
-    Map.of = function of () {
-      var keyValues = [], len = arguments.length;
-      while ( len-- ) keyValues[ len ] = arguments[ len ];
-
-      return emptyMap().withMutations(function (map) {
-        for (var i = 0; i < keyValues.length; i += 2) {
-          if (i + 1 >= keyValues.length) {
-            throw new Error('Missing value for key: ' + keyValues[i]);
-          }
-          map.set(keyValues[i], keyValues[i + 1]);
-        }
-      });
-    };
-
     Map.prototype.toString = function toString () {
       return this.__toString('Map {', '}');
     };
@@ -2900,7 +2902,7 @@
       }
     };
 
-  // eslint-disable-next-line no-unused-vars
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
   ValueNode.prototype.iterate = function (fn, reverse) {
     return fn(this.entry);
   };
@@ -3174,20 +3176,25 @@
     function List(value) {
       var empty = emptyList();
       if (value === undefined || value === null) {
+        // eslint-disable-next-line no-constructor-return
         return empty;
       }
       if (isList(value)) {
+        // eslint-disable-next-line no-constructor-return
         return value;
       }
       var iter = IndexedCollection(value);
       var size = iter.size;
       if (size === 0) {
+        // eslint-disable-next-line no-constructor-return
         return empty;
       }
       assertNotInfinite(size);
       if (size > 0 && size < SIZE) {
+        // eslint-disable-next-line no-constructor-return
         return makeList(0, size, SHIFT, null, new VNode(iter.toArray()));
       }
+      // eslint-disable-next-line no-constructor-return
       return empty.withMutations(function (list) {
         list.setSize(size);
         iter.forEach(function (v, i) { return list.set(i, v); });
@@ -3823,6 +3830,7 @@
 
   var OrderedMap = /*@__PURE__*/(function (Map) {
     function OrderedMap(value) {
+      // eslint-disable-next-line no-constructor-return
       return value === undefined || value === null
         ? emptyOrderedMap()
         : isOrderedMap(value)
@@ -3991,6 +3999,7 @@
 
   var Stack = /*@__PURE__*/(function (IndexedCollection) {
     function Stack(value) {
+      // eslint-disable-next-line no-constructor-return
       return value === undefined || value === null
         ? emptyStack()
         : isStack(value)
@@ -4289,6 +4298,9 @@
     return allEqual && a.size === bSize;
   }
 
+  /**
+   * Contributes additional methods to a constructor
+   */
   function mixin(ctor, methods) {
     var keyCopier = function (key) {
       ctor.prototype[key] = methods[key];
@@ -4325,6 +4337,7 @@
 
   var Set = /*@__PURE__*/(function (SetCollection) {
     function Set(value) {
+      // eslint-disable-next-line no-constructor-return
       return value === undefined || value === null
         ? emptySet()
         : isSet(value) && !isOrdered(value)
@@ -4571,15 +4584,23 @@
    */
   var Range = /*@__PURE__*/(function (IndexedSeq) {
     function Range(start, end, step) {
+      if ( step === void 0 ) step = 1;
+
       if (!(this instanceof Range)) {
+        // eslint-disable-next-line no-constructor-return
         return new Range(start, end, step);
       }
       invariant(step !== 0, 'Cannot step a Range by 0');
-      start = start || 0;
-      if (end === undefined) {
-        end = Infinity;
-      }
-      step = step === undefined ? 1 : Math.abs(step);
+      invariant(
+        start !== undefined,
+        'You must define a start value when using Range'
+      );
+      invariant(
+        end !== undefined,
+        'You must define an end value when using Range'
+      );
+
+      step = Math.abs(step);
       if (end < start) {
         step = -step;
       }
@@ -4589,8 +4610,10 @@
       this.size = Math.max(0, Math.ceil((end - start) / step - 1) + 1);
       if (this.size === 0) {
         if (EMPTY_RANGE) {
+          // eslint-disable-next-line no-constructor-return
           return EMPTY_RANGE;
         }
+        // eslint-disable-next-line @typescript-eslint/no-this-alias
         EMPTY_RANGE = this;
       }
     }
@@ -4734,13 +4757,6 @@
     return object;
   }
 
-  // Note: all of these methods are deprecated.
-  Collection.isIterable = isCollection;
-  Collection.isKeyed = isKeyed;
-  Collection.isIndexed = isIndexed;
-  Collection.isAssociative = isAssociative;
-  Collection.isOrdered = isOrdered;
-
   Collection.Iterator = Iterator;
 
   mixin(Collection, {
@@ -4975,6 +4991,7 @@
     },
 
     entrySeq: function entrySeq() {
+      // eslint-disable-next-line @typescript-eslint/no-this-alias
       var collection = this;
       if (collection._cache) {
         // We cache as an entries array, so we can just return the cache!
@@ -5425,7 +5442,8 @@
     var ordered = isOrdered(collection);
     var keyed = isKeyed(collection);
     var h = ordered ? 1 : 0;
-    var size = collection.__iterate(
+
+    collection.__iterate(
       keyed
         ? ordered
           ? function (v, k) {
@@ -5442,7 +5460,8 @@
             h = (h + hash(v)) | 0;
           }
     );
-    return murmurHashOfSize(size, h);
+
+    return murmurHashOfSize(collection.size, h);
   }
 
   function murmurHashOfSize(size, h) {
@@ -5462,6 +5481,7 @@
 
   var OrderedSet = /*@__PURE__*/(function (Set) {
     function OrderedSet(value) {
+      // eslint-disable-next-line no-constructor-return
       return value === undefined || value === null
         ? emptyOrderedSet()
         : isOrderedSet(value)
@@ -5605,6 +5625,7 @@
       RecordType.displayName = name;
     }
 
+    // eslint-disable-next-line no-constructor-return
     return RecordType;
   };
 
@@ -5772,14 +5793,17 @@
   var Repeat = /*@__PURE__*/(function (IndexedSeq) {
     function Repeat(value, times) {
       if (!(this instanceof Repeat)) {
+        // eslint-disable-next-line no-constructor-return
         return new Repeat(value, times);
       }
       this._value = value;
       this.size = times === undefined ? Infinity : Math.max(0, times);
       if (this.size === 0) {
         if (EMPTY_REPEAT) {
+          // eslint-disable-next-line no-constructor-return
           return EMPTY_REPEAT;
         }
+        // eslint-disable-next-line @typescript-eslint/no-this-alias
         EMPTY_REPEAT = this;
       }
     }
@@ -5856,7 +5880,7 @@
     Repeat.prototype.equals = function equals (other) {
       return other instanceof Repeat
         ? is(this._value, other._value)
-        : deepEqual(other);
+        : deepEqual(this, other);
     };
 
     return Repeat;
@@ -5905,7 +5929,7 @@
     return isIndexed(v) ? v.toList() : isKeyed(v) ? v.toMap() : v.toSet();
   }
 
-  var version = "5.0.0-beta.4";
+  var version = "5.0.0-rc.1";
 
   // Note: Iterable is deprecated
   var Iterable = Collection;
@@ -5958,6 +5982,4 @@
   exports.updateIn = updateIn$1;
   exports.version = version;
 
-  Object.defineProperty(exports, '__esModule', { value: true });
-
-})));
+}));

package/dist/immutable.js.flow

@@ -76,8 +76,10 @@ declare class _Collection<K, +V> implements ValueObject {
   has(key: K): boolean;
   includes(value: V): boolean;
   contains(value: V): boolean;
-  first<NSV>(notSetValue?: NSV): V | NSV;
-  last<NSV>(notSetValue?: NSV): V | NSV;
+  first(): V | void;
+  first<NSV>(notSetValue: NSV): V | NSV;
+  last(): V | void;
+  last<NSV>(notSetValue: NSV): V | NSV;
 
   hasIn(keyPath: Iterable<mixed>): boolean;