immutable 4.0.0-rc.8 → 4.0.0-rc.9

package/dist/immutable-nonambient.d.ts

@@ -99,287 +99,6 @@
 
 
 
-  /**
-   * Deeply converts plain JS objects and arrays to Immutable Maps and Lists.
-   *
-   * If a `reviver` is optionally provided, it will be called with every
-   * collection as a Seq (beginning with the most nested collections
-   * and proceeding to the top-level collection itself), along with the key
-   * refering to each collection and the parent JS object provided as `this`.
-   * For the top level, object, the key will be `""`. This `reviver` is expected
-   * to return a new Immutable Collection, allowing for custom conversions from
-   * deep JS objects. Finally, a `path` is provided which is the sequence of
-   * keys to this value from the starting value.
-   *
-   * `reviver` acts similarly to the [same parameter in `JSON.parse`][1].
-   *
-   * If `reviver` is not provided, the default behavior will convert Objects
-   * into Maps and Arrays into Lists like so:
-   *
-   * <!-- runkit:activate -->
-   * ```js
-   * const { fromJS, isKeyed } = require('immutable@4.0.0-rc.8')
-   * function (key, value) {
-   *   return isKeyed(value) ? value.Map() : value.toList()
-   * }
-   * ```
-   *
-   * `fromJS` is conservative in its conversion. It will only convert
-   * arrays which pass `Array.isArray` to Lists, and only raw objects (no custom
-   * prototype) to Map.
-   *
-   * Accordingly, this example converts native JS data to OrderedMap and List:
-   *
-   * <!-- runkit:activate -->
-   * ```js
-   * const { fromJS, isKeyed } = require('immutable@4.0.0-rc.8')
-   * fromJS({ a: {b: [10, 20, 30]}, c: 40}, function (key, value, path) {
-   *   console.log(key, value, path)
-   *   return isKeyed(value) ? value.toOrderedMap() : value.toList()
-   * })
-   *
-   * > "b", [ 10, 20, 30 ], [ "a", "b" ]
-   * > "a", {b: [10, 20, 30]}, [ "a" ]
-   * > "", {a: {b: [10, 20, 30]}, c: 40}, []
-   * ```
-   *
-   * Keep in mind, when using JS objects to construct Immutable Maps, that
-   * JavaScript Object properties are always strings, even if written in a
-   * quote-less shorthand, while Immutable Maps accept keys of any type.
-   *
-   * <!-- runkit:activate -->
-   * ```js
-   * const { Map } = require('immutable@4.0.0-rc.8')
-   * let obj = { 1: "one" };
-   * Object.keys(obj); // [ "1" ]
-   * assert.equal(obj["1"], obj[1]); // "one" === "one"
-   *
-   * let map = Map(obj);
-   * assert.notEqual(map.get("1"), map.get(1)); // "one" !== undefined
-   * ```
-   *
-   * Property access for JavaScript Objects first converts the key to a string,
-   * but since Immutable Map keys can be of any type the argument to `get()` is
-   * not altered.
-   *
-   * [1]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/parse#Example.3A_Using_the_reviver_parameter
-   *      "Using the reviver parameter"
-   */
-  export function fromJS(
-    jsValue: any,
-    reviver?: (
-      key: string | number,
-      sequence: Collection.Keyed<string, any> | Collection.Indexed<any>,
-      path?: Array<string | number>
-    ) => any
-  ): any;
-
-
-  /**
-   * Value equality check with semantics similar to `Object.is`, but treats
-   * Immutable `Collection`s as values, equal if the second `Collection` includes
-   * equivalent values.
-   *
-   * It's used throughout Immutable when checking for equality, including `Map`
-   * key equality and `Set` membership.
-   *
-   * <!-- runkit:activate -->
-   * ```js
-   * const { Map, is } = require('immutable@4.0.0-rc.8')
-   * const map1 = Map({ a: 1, b: 1, c: 1 })
-   * const map2 = Map({ a: 1, b: 1, c: 1 })
-   * assert.equal(map1 !== map2, true)
-   * assert.equal(Object.is(map1, map2), false)
-   * assert.equal(is(map1, map2), true)
-   * ```
-   *
-   * `is()` compares primitive types like strings and numbers, Immutable.js
-   * collections like `Map` and `List`, but also any custom object which
-   * implements `ValueObject` by providing `equals()` and `hashCode()` methods.
-   *
-   * Note: Unlike `Object.is`, `Immutable.is` assumes `0` and `-0` are the same
-   * value, matching the behavior of ES6 Map key equality.
-   */
-  export function is(first: any, second: any): boolean;
-
-
-  /**
-   * The `hash()` function is an important part of how Immutable determines if
-   * two values are equivalent and is used to determine how to store those
-   * values. Provided with any value, `hash()` will return a 31-bit integer.
-   *
-   * When designing Objects which may be equal, it's important than when a
-   * `.equals()` method returns true, that both values `.hashCode()` method
-   * return the same value. `hash()` may be used to produce those values.
-   *
-   * For non-Immutable Objects that do not provide a `.hashCode()` functions
-   * (including plain Objects, plain Arrays, Date objects, etc), a unique hash
-   * value will be created for each *instance*. That is, the create hash
-   * represents referential equality, and not value equality for Objects. This
-   * ensures that if that Object is mutated over time that its hash code will
-   * remain consistent, allowing Objects to be used as keys and values in
-   * Immutable.js collections.
-   *
-   * Note that `hash()` attempts to balance between speed and avoiding
-   * collisions, however it makes no attempt to produce secure hashes.
-   *
-   * *New in Version 4.0*
-   */
-  export function hash(value: any): number;
-
-  /**
-   * True if `maybeImmutable` is an Immutable Collection or Record.
-   *
-   * Note: Still returns true even if the collections is within a `withMutations()`.
-   *
-   * <!-- runkit:activate -->
-   * ```js
-   * const { isImmutable, Map, List, Stack } = require('immutable@4.0.0-rc.8');
-   * isImmutable([]); // false
-   * isImmutable({}); // false
-   * isImmutable(Map()); // true
-   * isImmutable(List()); // true
-   * isImmutable(Stack()); // true
-   * isImmutable(Map().asMutable()); // true
-   * ```
-   */
-  export function isImmutable(maybeImmutable: any): maybeImmutable is Collection<any, any>;
-
-  /**
-   * True if `maybeCollection` is a Collection, or any of its subclasses.
-   *
-   * <!-- runkit:activate -->
-   * ```js
-   * const { isCollection, Map, List, Stack } = require('immutable@4.0.0-rc.8');
-   * isCollection([]); // false
-   * isCollection({}); // false
-   * isCollection(Map()); // true
-   * isCollection(List()); // true
-   * isCollection(Stack()); // true
-   * ```
-   */
-  export function isCollection(maybeCollection: any): maybeCollection is Collection<any, any>;
-
-  /**
-   * True if `maybeKeyed` is a Collection.Keyed, or any of its subclasses.
-   *
-   * <!-- runkit:activate -->
-   * ```js
-   * const { isKeyed, Map, List, Stack } = require('immutable@4.0.0-rc.8');
-   * isKeyed([]); // false
-   * isKeyed({}); // false
-   * isKeyed(Map()); // true
-   * isKeyed(List()); // false
-   * isKeyed(Stack()); // false
-   * ```
-   */
-  export function isKeyed(maybeKeyed: any): maybeKeyed is Collection.Keyed<any, any>;
-
-  /**
-   * True if `maybeIndexed` is a Collection.Indexed, or any of its subclasses.
-   *
-   * <!-- runkit:activate -->
-   * ```js
-   * const { isIndexed, Map, List, Stack, Set } = require('immutable@4.0.0-rc.8');
-   * isIndexed([]); // false
-   * isIndexed({}); // false
-   * isIndexed(Map()); // false
-   * isIndexed(List()); // true
-   * isIndexed(Stack()); // true
-   * isIndexed(Set()); // false
-   * ```
-   */
-  export function isIndexed(maybeIndexed: any): maybeIndexed is Collection.Indexed<any>;
-
-  /**
-   * True if `maybeAssociative` is either a Keyed or Indexed Collection.
-   *
-   * <!-- runkit:activate -->
-   * ```js
-   * const { isAssociative, Map, List, Stack, Set } = require('immutable@4.0.0-rc.8');
-   * isAssociative([]); // false
-   * isAssociative({}); // false
-   * isAssociative(Map()); // true
-   * isAssociative(List()); // true
-   * isAssociative(Stack()); // true
-   * isAssociative(Set()); // false
-   * ```
-   */
-  export function isAssociative(maybeAssociative: any): maybeAssociative is Collection.Keyed<any, any> | Collection.Indexed<any>;
-
-  /**
-   * True if `maybeOrdered` is a Collection where iteration order is well
-   * defined. True for Collection.Indexed as well as OrderedMap and OrderedSet.
-   *
-   * <!-- runkit:activate -->
-   * ```js
-   * const { isOrdered, Map, OrderedMap, List, Set } = require('immutable@4.0.0-rc.8');
-   * isOrdered([]); // false
-   * isOrdered({}); // false
-   * isOrdered(Map()); // false
-   * isOrdered(OrderedMap()); // true
-   * isOrdered(List()); // true
-   * isOrdered(Set()); // false
-   * ```
-   */
-  export function isOrdered(maybeOrdered: any): boolean;
-
-  /**
-   * True if `maybeValue` is a JavaScript Object which has *both* `equals()`
-   * and `hashCode()` methods.
-   *
-   * Any two instances of *value objects* can be compared for value equality with
-   * `Immutable.is()` and can be used as keys in a `Map` or members in a `Set`.
-   */
-  export function isValueObject(maybeValue: any): maybeValue is ValueObject;
-
-  /**
-   * The interface to fulfill to qualify as a Value Object.
-   */
-  export interface ValueObject {
-    /**
-     * True if this and the other Collection have value equality, as defined
-     * by `Immutable.is()`.
-     *
-     * Note: This is equivalent to `Immutable.is(this, other)`, but provided to
-     * allow for chained expressions.
-     */
-    equals(other: any): boolean;
-
-    /**
-     * Computes and returns the hashed identity for this Collection.
-     *
-     * The `hashCode` of a Collection is used to determine potential equality,
-     * and is used when adding this to a `Set` or as a key in a `Map`, enabling
-     * lookup via a different instance.
-     *
-     * <!-- runkit:activate -->
-     * ```js
-     * const { List, Set } = require('immutable@4.0.0-rc.8');
-     * const a = List([ 1, 2, 3 ]);
-     * const b = List([ 1, 2, 3 ]);
-     * assert.notStrictEqual(a, b); // different instances
-     * const set = Set([ a ]);
-     * assert.equal(set.has(b), true);
-     * ```
-     *
-     * Note: hashCode() MUST return a Uint32 number. The easiest way to
-     * guarantee this is to return `myHash | 0` from a custom implementation.
-     *
-     * If two values have the same `hashCode`, they are [not guaranteed
-     * to be equal][Hash Collision]. If two values have different `hashCode`s,
-     * they must not be equal.
-     *
-     * Note: `hashCode()` is not guaranteed to always be called before
-     * `equals()`. Most but not all Immutable.js collections use hash codes to
-     * organize their internal data structures, while all Immutable.js
-     * collections use equality during lookups.
-     *
-     * [Hash Collision]: http://en.wikipedia.org/wiki/Collision_(computer_science)
-     */
-    hashCode(): number;
-  }
-
   /**
    * Lists are ordered indexed dense collections, much like a JavaScript
    * Array.
@@ -401,7 +120,7 @@
      *
      * <!-- runkit:activate -->
      * ```js
-     * const { List } = require('immutable@4.0.0-rc.8');
+     * const { List } = require('immutable@4.0.0-rc.9');
      * List.isList([]); // false
      * List.isList(List()); // true
      * ```
@@ -413,7 +132,7 @@
      *
      * <!-- runkit:activate -->
      * ```js
-     * const { List } = require('immutable@4.0.0-rc.8');
+     * const { List } = require('immutable@4.0.0-rc.9');
      * List.of(1, 2, 3, 4)
      * // List [ 1, 2, 3, 4 ]
      * ```
@@ -422,7 +141,7 @@
      *
      * <!-- runkit:activate -->
      * ```js
-     * const { List } = require('immutable@4.0.0-rc.8');
+     * const { List } = require('immutable@4.0.0-rc.9');
      * List.of({x:1}, 2, [3], 4)
      * // List [ { x: 1 }, 2, [ 3 ], 4 ]
      * ```
@@ -436,7 +155,7 @@
    *
    * <!-- runkit:activate -->
    * ```js
-   * const { List, Set } = require('immutable@4.0.0-rc.8')
+   * const { List, Set } = require('immutable@4.0.0-rc.9')
    *
    * const emptyList = List()
    * // List []
@@ -482,7 +201,7 @@
      * enough to include the `index`.
      *
      * <!-- runkit:activate
-     *      { "preamble": "const { List } = require('immutable@4.0.0-rc.8');" }
+     *      { "preamble": "const { List } = require('immutable@4.0.0-rc.9');" }
      * -->
      * ```js
      * const originalList = List([ 0 ]);
@@ -515,7 +234,7 @@
      * Note: `delete` cannot be safely used in IE8
      *
      * <!-- runkit:activate
-     *      { "preamble": "const { List } = require('immutable@4.0.0-rc.8');" }
+     *      { "preamble": "const { List } = require('immutable@4.0.0-rc.9');" }
      * -->
      * ```js
      * List([ 0, 1, 2, 3, 4 ]).delete(0);
@@ -539,7 +258,7 @@
      * This is synonymous with `list.splice(index, 0, value)`.
      *
      * <!-- runkit:activate
-     *      { "preamble": "const { List } = require('immutable@4.0.0-rc.8');" }
+     *      { "preamble": "const { List } = require('immutable@4.0.0-rc.9');" }
      * -->
      * ```js
      * List([ 0, 1, 2, 3, 4 ]).insert(6, 5)
@@ -557,7 +276,7 @@
      * Returns a new List with 0 size and no values in constant time.
      *
      * <!-- runkit:activate
-     *      { "preamble": "const { List } = require('immutable@4.0.0-rc.8');" }
+     *      { "preamble": "const { List } = require('immutable@4.0.0-rc.9');" }
      * -->
      * ```js
      * List([ 1, 2, 3, 4 ]).clear()
@@ -573,7 +292,7 @@
      * List's `size`.
      *
      * <!-- runkit:activate
-     *      { "preamble": "const { List } = require('immutable@4.0.0-rc.8');" }
+     *      { "preamble": "const { List } = require('immutable@4.0.0-rc.9');" }
      * -->
      * ```js
      * List([ 1, 2, 3, 4 ]).push(5)
@@ -606,7 +325,7 @@
      * values ahead to higher indices.
      *
      * <!-- runkit:activate
-     *      { "preamble": "const { List } = require('immutable@4.0.0-rc.8');" }
+     *      { "preamble": "const { List } = require('immutable@4.0.0-rc.9');" }
      * -->
      * ```js
      * List([ 2, 3, 4]).unshift(1);
@@ -626,7 +345,7 @@
      * value in this List.
      *
      * <!-- runkit:activate
-     *      { "preamble": "const { List } = require('immutable@4.0.0-rc.8');" }
+     *      { "preamble": "const { List } = require('immutable@4.0.0-rc.9');" }
      * -->
      * ```js
      * List([ 0, 1, 2, 3, 4 ]).shift();
@@ -647,7 +366,7 @@
      * List. `v.update(-1)` updates the last item in the List.
      *
      * <!-- runkit:activate
-     *      { "preamble": "const { List } = require('immutable@4.0.0-rc.8');" }
+     *      { "preamble": "const { List } = require('immutable@4.0.0-rc.9');" }
      * -->
      * ```js
      * const list = List([ 'a', 'b', 'c' ])
@@ -661,7 +380,7 @@
      * For example, to sum a List after mapping and filtering:
      *
      * <!-- runkit:activate
-     *      { "preamble": "const { List } = require('immutable@4.0.0-rc.8');" }
+     *      { "preamble": "const { List } = require('immutable@4.0.0-rc.9');" }
      * -->
      * ```js
      * function sum(collection) {
@@ -707,7 +426,7 @@
      *
      * <!-- runkit:activate -->
      * ```js
-     * const { List } = require('immutable@4.0.0-rc.8')
+     * const { List } = require('immutable@4.0.0-rc.9')
      * const list = List([ 0, 1, 2, List([ 3, 4 ])])
      * list.setIn([3, 0], 999);
      * // List [ 0, 1, 2, List [ 999, 4 ] ]
@@ -719,7 +438,7 @@
      *
      * <!-- runkit:activate -->
      * ```js
-     * const { List } = require('immutable@4.0.0-rc.8')
+     * const { List } = require('immutable@4.0.0-rc.9')
      * const list = List([ 0, 1, 2, { plain: 'object' }])
      * list.setIn([3, 'plain'], 'value');
      * // List([ 0, 1, 2, { plain: 'value' }])
@@ -735,7 +454,7 @@
      *
      * <!-- runkit:activate -->
      * ```js
-     * const { List } = require('immutable@4.0.0-rc.8')
+     * const { List } = require('immutable@4.0.0-rc.9')
      * const list = List([ 0, 1, 2, List([ 3, 4 ])])
      * list.deleteIn([3, 0]);
      * // List [ 0, 1, 2, List [ 4 ] ]
@@ -747,7 +466,7 @@
      *
      * <!-- runkit:activate -->
      * ```js
-     * const { List } = require('immutable@4.0.0-rc.8')
+     * const { List } = require('immutable@4.0.0-rc.9')
      * const list = List([ 0, 1, 2, { plain: 'object' }])
      * list.removeIn([3, 'plain']);
      * // List([ 0, 1, 2, {}])
@@ -831,7 +550,7 @@
      * `mapper` function.
      *
      * <!-- runkit:activate
-     *      { "preamble": "const { List } = require('immutable@4.0.0-rc.8');" }
+     *      { "preamble": "const { List } = require('immutable@4.0.0-rc.9');" }
      * -->
      * ```js
      * List([ 1, 2 ]).map(x => 10 * x)
@@ -878,7 +597,7 @@
      * Like `zipWith`, but using the default `zipper`: creating an `Array`.
      *
      * <!-- runkit:activate
-     *      { "preamble": "const { List } = require('immutable@4.0.0-rc.8');" }
+     *      { "preamble": "const { List } = require('immutable@4.0.0-rc.9');" }
      * -->
      * ```js
      * const a = List([ 1, 2, 3 ]);
@@ -897,7 +616,7 @@
      * exhausted. Missing values from shorter collections are filled with `undefined`.
      *
      * <!-- runkit:activate
-     *      { "preamble": "const { List } = require('immutable@4.0.0-rc.8');" }
+     *      { "preamble": "const { List } = require('immutable@4.0.0-rc.9');" }
      * -->
      * ```js
      * const a = List([ 1, 2 ]);
@@ -918,7 +637,7 @@
      * custom `zipper` function.
      *
      * <!-- runkit:activate
-     *      { "preamble": "const { List } = require('immutable@4.0.0-rc.8');" }
+     *      { "preamble": "const { List } = require('immutable@4.0.0-rc.9');" }
      * -->
      * ```js
      * const a = List([ 1, 2, 3 ]);
@@ -959,7 +678,7 @@
    *
    * <!-- runkit:activate -->
    * ```js
-   * const { Map, List } = require('immutable@4.0.0-rc.8');
+   * const { Map, List } = require('immutable@4.0.0-rc.9');
    * Map().set(List([ 1 ]), 'listofone').get(List([ 1 ]));
    * // 'listofone'
    * ```
@@ -977,7 +696,7 @@
      *
      * <!-- runkit:activate -->
      * ```js
-     * const { Map } = require('immutable@4.0.0-rc.8')
+     * const { Map } = require('immutable@4.0.0-rc.9')
      * Map.isMap({}) // false
      * Map.isMap(Map()) // true
      * ```
@@ -989,7 +708,7 @@
      *
      * <!-- runkit:activate -->
      * ```js
-     * const { Map } = require('immutable@4.0.0-rc.8')
+     * const { Map } = require('immutable@4.0.0-rc.9')
      * Map.of(
      *   'key', 'value',
      *   'numerical value', 3,
@@ -1011,7 +730,7 @@
    *
    * <!-- runkit:activate -->
    * ```js
-   * const { Map } = require('immutable@4.0.0-rc.8')
+   * const { Map } = require('immutable@4.0.0-rc.9')
    * Map({ key: "value" })
    * Map([ [ "key", "value" ] ])
    * ```
@@ -1021,7 +740,7 @@
    * quote-less shorthand, while Immutable Maps accept keys of any type.
    *
    * <!-- runkit:activate
-   *      { "preamble": "const { Map } = require('immutable@4.0.0-rc.8');" }
+   *      { "preamble": "const { Map } = require('immutable@4.0.0-rc.9');" }
    * -->
    * ```js
    * let obj = { 1: "one" }
@@ -1057,7 +776,7 @@
      *
      * <!-- runkit:activate -->
      * ```js
-     * const { Map } = require('immutable@4.0.0-rc.8')
+     * const { Map } = require('immutable@4.0.0-rc.9')
      * const originalMap = Map()
      * const newerMap = originalMap.set('key', 'value')
      * const newestMap = newerMap.set('key', 'newer value')
@@ -1082,7 +801,7 @@
      *
      * <!-- runkit:activate -->
      * ```js
-     * const { Map } = require('immutable@4.0.0-rc.8')
+     * const { Map } = require('immutable@4.0.0-rc.9')
      * const originalMap = Map({
      *   key: 'value',
      *   otherKey: 'other value'
@@ -1104,7 +823,7 @@
      *
      * <!-- runkit:activate -->
      * ```js
-     * const { Map } = require('immutable@4.0.0-rc.8')
+     * const { Map } = require('immutable@4.0.0-rc.9')
      * const names = Map({ a: "Aaron", b: "Barry", c: "Connor" })
      * names.deleteAll([ 'a', 'c' ])
      * // Map { "b": "Barry" }
@@ -1122,7 +841,7 @@
      *
      * <!-- runkit:activate -->
      * ```js
-     * const { Map } = require('immutable@4.0.0-rc.8')
+     * const { Map } = require('immutable@4.0.0-rc.9')
      * Map({ key: 'value' }).clear()
      * // Map {}
      * ```
@@ -1139,7 +858,7 @@
      *
      * <!-- runkit:activate -->
      * ```js
-     * const { Map } = require('immutable@4.0.0-rc.8')
+     * const { Map } = require('immutable@4.0.0-rc.9')
      * const aMap = Map({ key: 'value' })
      * const newMap = aMap.update('key', value => value + value)
      * // Map { "key": "valuevalue" }
@@ -1150,7 +869,7 @@
      * `update` and `push` can be used together:
      *
      * <!-- runkit:activate
-     *      { "preamble": "const { Map, List } = require('immutable@4.0.0-rc.8');" }
+     *      { "preamble": "const { Map, List } = require('immutable@4.0.0-rc.9');" }
      * -->
      * ```js
      * const aMap = Map({ nestedList: List([ 1, 2, 3 ]) })
@@ -1162,7 +881,7 @@
      * function when the value at the key does not exist in the Map.
      *
      * <!-- runkit:activate
-     *      { "preamble": "const { Map } = require('immutable@4.0.0-rc.8');" }
+     *      { "preamble": "const { Map } = require('immutable@4.0.0-rc.9');" }
      * -->
      * ```js
      * const aMap = Map({ key: 'value' })
@@ -1175,7 +894,7 @@
      * is provided.
      *
      * <!-- runkit:activate
-     *      { "preamble": "const { Map } = require('immutable@4.0.0-rc.8');" }
+     *      { "preamble": "const { Map } = require('immutable@4.0.0-rc.9');" }
      * -->
      * ```js
      * const aMap = Map({ apples: 10 })
@@ -1191,7 +910,7 @@
      * The previous example behaves differently when written with default values:
      *
      * <!-- runkit:activate
-     *      { "preamble": "const { Map } = require('immutable@4.0.0-rc.8');" }
+     *      { "preamble": "const { Map } = require('immutable@4.0.0-rc.9');" }
      * -->
      * ```js
      * const aMap = Map({ apples: 10 })
@@ -1203,7 +922,7 @@
      * returned as well.
      *
      * <!-- runkit:activate
-     *      { "preamble": "const { Map } = require('immutable@4.0.0-rc.8');" }
+     *      { "preamble": "const { Map } = require('immutable@4.0.0-rc.9');" }
      * -->
      * ```js
      * const aMap = Map({ key: 'value' })
@@ -1217,7 +936,7 @@
      * For example, to sum the values in a Map
      *
      * <!-- runkit:activate
-     *      { "preamble": "const { Map } = require('immutable@4.0.0-rc.8');" }
+     *      { "preamble": "const { Map } = require('immutable@4.0.0-rc.9');" }
      * -->
      * ```js
      * function sum(collection) {
@@ -1247,7 +966,7 @@
      *
      * <!-- runkit:activate -->
      * ```js
-     * const { Map } = require('immutable@4.0.0-rc.8')
+     * const { Map } = require('immutable@4.0.0-rc.9')
      * const one = Map({ a: 10, b: 20, c: 30 })
      * const two = Map({ b: 40, a: 50, d: 60 })
      * one.merge(two) // Map { "a": 50, "b": 40, "c": 30, "d": 60 }
@@ -1270,7 +989,7 @@
      *
      * <!-- runkit:activate -->
      * ```js
-     * const { Map } = require('immutable@4.0.0-rc.8')
+     * const { Map } = require('immutable@4.0.0-rc.9')
      * const one = Map({ a: 10, b: 20, c: 30 })
      * const two = Map({ b: 40, a: 50, d: 60 })
      * one.mergeWith((oldVal, newVal) => oldVal / newVal, two)
@@ -1296,7 +1015,7 @@
      *
      * <!-- runkit:activate -->
      * ```js
-     * const { Map } = require('immutable@4.0.0-rc.8')
+     * const { Map } = require('immutable@4.0.0-rc.9')
      * const one = Map({ a: Map({ x: 10, y: 10 }), b: Map({ x: 20, y: 50 }) })
      * const two = Map({ a: Map({ x: 2 }), b: Map({ y: 5 }), c: Map({ z: 3 }) })
      * one.mergeDeep(two)
@@ -1317,7 +1036,7 @@
      *
      * <!-- runkit:activate -->
      * ```js
-     * const { Map } = require('immutable@4.0.0-rc.8')
+     * const { Map } = require('immutable@4.0.0-rc.9')
      * const one = Map({ a: Map({ x: 10, y: 10 }), b: Map({ x: 20, y: 50 }) })
      * const two = Map({ a: Map({ x: 2 }), b: Map({ y: 5 }), c: Map({ z: 3 }) })
      * one.mergeDeepWith((oldVal, newVal) => oldVal / newVal, two)
@@ -1344,7 +1063,7 @@
      *
      * <!-- runkit:activate -->
      * ```js
-     * const { Map } = require('immutable@4.0.0-rc.8')
+     * const { Map } = require('immutable@4.0.0-rc.9')
      * const originalMap = Map({
      *   subObject: Map({
      *     subKey: 'subvalue',
@@ -1380,7 +1099,7 @@
      *
      * <!-- runkit:activate -->
      * ```js
-     * const { Map } = require('immutable@4.0.0-rc.8')
+     * const { Map } = require('immutable@4.0.0-rc.9')
      * const originalMap = Map({
      *   subObject: {
      *     subKey: 'subvalue',
@@ -1427,7 +1146,7 @@
      *
      * <!-- runkit:activate -->
      * ```js
-     * const { Map, List } = require('immutable@4.0.0-rc.8')
+     * const { Map, List } = require('immutable@4.0.0-rc.9')
      * const map = Map({ inMap: Map({ inList: List([ 1, 2, 3 ]) }) })
      * const newMap = map.updateIn(['inMap', 'inList'], list => list.push(4))
      * // Map { "inMap": Map { "inList": List [ 1, 2, 3, 4 ] } }
@@ -1439,7 +1158,7 @@
      * provided, otherwise `undefined`.
      *
      * <!-- runkit:activate
-     *      { "preamble": "const { Map } = require('immutable@4.0.0-rc.8')" }
+     *      { "preamble": "const { Map } = require('immutable@4.0.0-rc.9')" }
      * -->
      * ```js
      * const map = Map({ a: Map({ b: Map({ c: 10 }) }) })
@@ -1451,7 +1170,7 @@
      * no change will occur. This is still true if `notSetValue` is provided.
      *
      * <!-- runkit:activate
-     *      { "preamble": "const { Map } = require('immutable@4.0.0-rc.8')" }
+     *      { "preamble": "const { Map } = require('immutable@4.0.0-rc.9')" }
      * -->
      * ```js
      * const map = Map({ a: Map({ b: Map({ c: 10 }) }) })
@@ -1467,7 +1186,7 @@
      * The previous example behaves differently when written with default values:
      *
      * <!-- runkit:activate
-     *      { "preamble": "const { Map } = require('immutable@4.0.0-rc.8')" }
+     *      { "preamble": "const { Map } = require('immutable@4.0.0-rc.9')" }
      * -->
      * ```js
      * const map = Map({ a: Map({ b: Map({ c: 10 }) }) })
@@ -1480,7 +1199,7 @@
      * immutably by creating new copies of those values with the changes applied.
      *
      * <!-- runkit:activate
-     *      { "preamble": "const { Map } = require('immutable@4.0.0-rc.8')" }
+     *      { "preamble": "const { Map } = require('immutable@4.0.0-rc.9')" }
      * -->
      * ```js
      * const map = Map({ a: { b: { c: 10 } } })
@@ -1541,7 +1260,7 @@
      *
      * <!-- runkit:activate -->
      * ```js
-     * const { Map } = require('immutable@4.0.0-rc.8')
+     * const { Map } = require('immutable@4.0.0-rc.9')
      * const map1 = Map()
      * const map2 = map1.withMutations(map => {
      *   map.set('a', 1).set('b', 2).set('c', 3)
@@ -1709,7 +1428,7 @@
      *
      * <!-- runkit:activate -->
      * ```js
-     * const { OrderedMap } = require('immutable@4.0.0-rc.8')
+     * const { OrderedMap } = require('immutable@4.0.0-rc.9')
      * const one = OrderedMap({ a: 10, b: 20, c: 30 })
      * const two = OrderedMap({ b: 40, a: 50, d: 60 })
      * one.merge(two) // OrderedMap { "a": 50, "b": 40, "c": 30, "d": 60 }
@@ -1826,7 +1545,7 @@
      * a collection of other sets.
      *
      * ```js
-     * const { Set } = require('immutable@4.0.0-rc.8')
+     * const { Set } = require('immutable@4.0.0-rc.9')
      * const intersected = Set.intersect([
      *   Set([ 'a', 'b', 'c' ])
      *   Set([ 'c', 'a', 't' ])
@@ -1841,7 +1560,7 @@
      * collection of other sets.
      *
      * ```js
-     * const { Set } = require('immutable@4.0.0-rc.8')
+     * const { Set } = require('immutable@4.0.0-rc.9')
      * const unioned = Set.union([
      *   Set([ 'a', 'b', 'c' ])
      *   Set([ 'c', 'a', 't' ])
@@ -2412,7 +2131,7 @@
    * infinity. When `start` is equal to `end`, returns empty range.
    *
    * ```js
-   * const { Range } = require('immutable@4.0.0-rc.8')
+   * const { Range } = require('immutable@4.0.0-rc.9')
    * Range() // [ 0, 1, 2, 3, ... ]
    * Range(10) // [ 10, 11, 12, 13, ... ]
    * Range(10, 15) // [ 10, 11, 12, 13, 14 ]
@@ -2429,7 +2148,7 @@
    * not defined, returns an infinite `Seq` of `value`.
    *
    * ```js
-   * const { Repeat } = require('immutable@4.0.0-rc.8')
+   * const { Repeat } = require('immutable@4.0.0-rc.9')
    * Repeat('foo') // [ 'foo', 'foo', 'foo', ... ]
    * Repeat('bar', 4) // [ 'bar', 'bar', 'bar', 'bar' ]
    * ```
@@ -2445,7 +2164,7 @@
    * create Record instances.
    *
    * ```js
-   * const { Record } = require('immutable@4.0.0-rc.8')
+   * const { Record } = require('immutable@4.0.0-rc.9')
    * const ABRecord = Record({ a: 1, b: 2 })
    * const myRecord = new ABRecord({ b: 3 })
    * ```
@@ -2577,7 +2296,7 @@
      * method. If one was not provided, the string "Record" is returned.
      *
      * ```js
-     * const { Record } = require('immutable@4.0.0-rc.8')
+     * const { Record } = require('immutable@4.0.0-rc.9')
      * const Person = Record({
      *   name: null
      * }, 'Person')
@@ -2595,7 +2314,7 @@
      * type:
      *
      * <!-- runkit:activate
-     *      { "preamble": "const { Record } = require('immutable@4.0.0-rc.8')" }
+     *      { "preamble": "const { Record } = require('immutable@4.0.0-rc.9')" }
      * -->
      * ```js
      * // makePerson is a Record Factory function
@@ -2610,7 +2329,7 @@
      * access on the resulting instances:
      *
      * <!-- runkit:activate
-     *      { "preamble": "const { Record } = require('immutable@4.0.0-rc.8');const makePerson = Record({ name: null, favoriteColor: 'unknown' });const alan = makePerson({ name: 'Alan' });" }
+     *      { "preamble": "const { Record } = require('immutable@4.0.0-rc.9');const makePerson = Record({ name: null, favoriteColor: 'unknown' });const alan = makePerson({ name: 'Alan' });" }
      * -->
      * ```js
      * // Use the Record API
@@ -2792,7 +2511,7 @@
    * `Seq`'s values are never iterated:
    *
    * ```js
-   * const { Seq } = require('immutable@4.0.0-rc.8')
+   * const { Seq } = require('immutable@4.0.0-rc.9')
    * const oddSquares = Seq([ 1, 2, 3, 4, 5, 6, 7, 8 ])
    *   .filter(x => x % 2 !== 0)
    *   .map(x => x * x)
@@ -2831,7 +2550,7 @@
    *
    * <!-- runkit:activate -->
    * ```js
-   * const { Range } = require('immutable@4.0.0-rc.8')
+   * const { Range } = require('immutable@4.0.0-rc.9')
    * Range(1, Infinity)
    *   .skip(1000)
    *   .map(n => -n)
@@ -2910,7 +2629,7 @@
        * `mapper` function.
        *
        * ```js
-       * const { Seq } = require('immutable@4.0.0-rc.8')
+       * const { Seq } = require('immutable@4.0.0-rc.9')
        * Seq.Keyed({ a: 1, b: 2 }).map(x => 10 * x)
        * // Seq { "a": 10, "b": 20 }
        * ```
@@ -3022,7 +2741,7 @@
        * `mapper` function.
        *
        * ```js
-       * const { Seq } = require('immutable@4.0.0-rc.8')
+       * const { Seq } = require('immutable@4.0.0-rc.9')
        * Seq.Indexed([ 1, 2 ]).map(x => 10 * x)
        * // Seq [ 10, 20 ]
        * ```
@@ -3282,7 +3001,7 @@
      * `mapper` function.
      *
      * ```js
-     * const { Seq } = require('immutable@4.0.0-rc.8')
+     * const { Seq } = require('immutable@4.0.0-rc.9')
      * Seq([ 1, 2 ]).map(x => 10 * x)
      * // Seq [ 10, 20 ]
      * ```
@@ -3300,7 +3019,7 @@
      * `mapper` function.
      *
      * ```js
-     * const { Seq } = require('immutable@4.0.0-rc.8')
+     * const { Seq } = require('immutable@4.0.0-rc.9')
      * Seq([ 1, 2 ]).map(x => 10 * x)
      * // Seq [ 10, 20 ]
      * ```
@@ -3369,22 +3088,22 @@
   export module Collection {
 
     /**
-     * @deprecated use `const { isKeyed } = require('immutable@4.0.0-rc.8')`
+     * @deprecated use `const { isKeyed } = require('immutable@4.0.0-rc.9')`
      */
     function isKeyed(maybeKeyed: any): maybeKeyed is Collection.Keyed<any, any>;
 
     /**
-     * @deprecated use `const { isIndexed } = require('immutable@4.0.0-rc.8')`
+     * @deprecated use `const { isIndexed } = require('immutable@4.0.0-rc.9')`
      */
     function isIndexed(maybeIndexed: any): maybeIndexed is Collection.Indexed<any>;
 
     /**
-     * @deprecated use `const { isAssociative } = require('immutable@4.0.0-rc.8')`
+     * @deprecated use `const { isAssociative } = require('immutable@4.0.0-rc.9')`
      */
     function isAssociative(maybeAssociative: any): maybeAssociative is Collection.Keyed<any, any> | Collection.Indexed<any>;
 
     /**
-     * @deprecated use `const { isOrdered } = require('immutable@4.0.0-rc.8')`
+     * @deprecated use `const { isOrdered } = require('immutable@4.0.0-rc.9')`
      */
     function isOrdered(maybeOrdered: any): boolean;
 
@@ -3442,7 +3161,7 @@
        *
        * <!-- runkit:activate -->
        * ```js
-       * const { Map } = require('immutable@4.0.0-rc.8')
+       * const { Map } = require('immutable@4.0.0-rc.9')
        * Map({ a: 'z', b: 'y' }).flip()
        * // Map { "z": "a", "y": "b" }
        * ```
@@ -3460,7 +3179,7 @@
        * `mapper` function.
        *
        * ```js
-       * const { Collection } = require('immutable@4.0.0-rc.8')
+       * const { Collection } = require('immutable@4.0.0-rc.9')
        * Collection.Keyed({ a: 1, b: 2 }).map(x => 10 * x)
        * // Seq { "a": 10, "b": 20 }
        * ```
@@ -3479,7 +3198,7 @@
        *
        * <!-- runkit:activate -->
        * ```js
-       * const { Map } = require('immutable@4.0.0-rc.8')
+       * const { Map } = require('immutable@4.0.0-rc.9')
        * Map({ a: 1, b: 2 }).mapKeys(x => x.toUpperCase())
        * // Map { "A": 1, "B": 2 }
        * ```
@@ -3498,7 +3217,7 @@
        *
        * <!-- runkit:activate -->
        * ```js
-       * const { Map } = require('immutable@4.0.0-rc.8')
+       * const { Map } = require('immutable@4.0.0-rc.9')
        * Map({ a: 1, b: 2 })
        *   .mapEntries(([ k, v ]) => [ k.toUpperCase(), v * 2 ])
        * // Map { "A": 2, "B": 4 }
@@ -3624,10 +3343,10 @@
        * second from each, etc.
        *
        * <!-- runkit:activate
-       *      { "preamble": "require('immutable@4.0.0-rc.8')"}
+       *      { "preamble": "require('immutable@4.0.0-rc.9')"}
        * -->
        * ```js
-       * const { List } = require('immutable@4.0.0-rc.8')
+       * const { List } = require('immutable@4.0.0-rc.9')
        * List([ 1, 2, 3 ]).interleave(List([ 'A', 'B', 'C' ]))
        * // List [ 1, "A", 2, "B", 3, "C"" ]
        * ```
@@ -3635,7 +3354,7 @@
        * The shortest Collection stops interleave.
        *
        * <!-- runkit:activate
-       *      { "preamble": "const { List } = require('immutable@4.0.0-rc.8')" }
+       *      { "preamble": "const { List } = require('immutable@4.0.0-rc.9')" }
        * -->
        * ```js
        * List([ 1, 2, 3 ]).interleave(
@@ -3662,7 +3381,7 @@
        *
        * <!-- runkit:activate -->
        * ```js
-       * const { List } = require('immutable@4.0.0-rc.8')
+       * const { List } = require('immutable@4.0.0-rc.9')
        * List([ 'a', 'b', 'c', 'd' ]).splice(1, 2, 'q', 'r', 's')
        * // List [ "a", "q", "r", "s", "d" ]
        * ```
@@ -3686,7 +3405,7 @@
        *
        *
        * <!-- runkit:activate
-       *      { "preamble": "const { List } = require('immutable@4.0.0-rc.8')" }
+       *      { "preamble": "const { List } = require('immutable@4.0.0-rc.9')" }
        * -->
        * ```js
        * const a = List([ 1, 2, 3 ]);
@@ -3719,7 +3438,7 @@
        * collections by using a custom `zipper` function.
        *
        * <!-- runkit:activate
-       *      { "preamble": "const { List } = require('immutable@4.0.0-rc.8')" }
+       *      { "preamble": "const { List } = require('immutable@4.0.0-rc.9')" }
        * -->
        * ```js
        * const a = List([ 1, 2, 3 ]);
@@ -3787,7 +3506,7 @@
        * `mapper` function.
        *
        * ```js
-       * const { Collection } = require('immutable@4.0.0-rc.8')
+       * const { Collection } = require('immutable@4.0.0-rc.9')
        * Collection.Indexed([1,2]).map(x => 10 * x)
        * // Seq [ 1, 2 ]
        * ```
@@ -3839,7 +3558,7 @@
      * the value as both the first and second arguments to the provided function.
      *
      * ```js
-     * const { Collection } = require('immutable@4.0.0-rc.8')
+     * const { Collection } = require('immutable@4.0.0-rc.9')
      * const seq = Collection.Set([ 'A', 'B', 'C' ])
      * // Seq { "A", "B", "C" }
      * seq.forEach((v, k) =>
@@ -3971,7 +3690,7 @@
      * lookup via a different instance.
      *
      * <!-- runkit:activate
-     *      { "preamble": "const { Set,  List } = require('immutable@4.0.0-rc.8')" }
+     *      { "preamble": "const { Set,  List } = require('immutable@4.0.0-rc.9')" }
      * -->
      * ```js
      * const a = List([ 1, 2, 3 ]);
@@ -4036,7 +3755,7 @@
      *
      * <!-- runkit:activate -->
      * ```js
-     * const { Map, List } = require('immutable@4.0.0-rc.8')
+     * const { Map, List } = require('immutable@4.0.0-rc.9')
      * const deepData = Map({ x: List([ Map({ y: 123 }) ]) });
      * getIn(deepData, ['x', 0, 'y']) // 123
      * ```
@@ -4046,7 +3765,7 @@
      *
      * <!-- runkit:activate -->
      * ```js
-     * const { Map, List } = require('immutable@4.0.0-rc.8')
+     * const { Map, List } = require('immutable@4.0.0-rc.9')
      * const deepData = Map({ x: [ { y: 123 } ] });
      * getIn(deepData, ['x', 0, 'y']) // 123
      * ```
@@ -4069,7 +3788,7 @@
      *
      * <!-- runkit:activate -->
      * ```js
-     * const { Seq } = require('immutable@4.0.0-rc.8')
+     * const { Seq } = require('immutable@4.0.0-rc.9')
      *
      * function sum(collection) {
      *   return collection.reduce((sum, x) => sum + x, 0)
@@ -4165,7 +3884,7 @@
      *
      * <!-- runkit:activate -->
      * ```js
-     * const { Map, List } = require('immutable@4.0.0-rc.8')
+     * const { Map, List } = require('immutable@4.0.0-rc.9')
      * var myMap = Map({ a: 'Apple', b: 'Banana' })
      * List(myMap) // List [ [ "a", "Apple" ], [ "b", "Banana" ] ]
      * myMap.toList() // List [ "Apple", "Banana" ]
@@ -4202,7 +3921,7 @@
      *
      * <!-- runkit:activate -->
      * ```js
-     * const { Seq } = require('immutable@4.0.0-rc.8')
+     * const { Seq } = require('immutable@4.0.0-rc.9')
      * const indexedSeq = Seq([ 'A', 'B', 'C' ])
      * // Seq [ "A", "B", "C" ]
      * indexedSeq.filter(v => v === 'B')
@@ -4283,7 +4002,7 @@
      *
      * <!-- runkit:activate -->
      * ```js
-     * const { Collection } = require('immutable@4.0.0-rc.8')
+     * const { Collection } = require('immutable@4.0.0-rc.9')
      * Collection({ a: 1, b: 2 }).map(x => 10 * x)
      * // Seq { "a": 10, "b": 20 }
      * ```
@@ -4310,7 +4029,7 @@
      *
      * <!-- runkit:activate -->
      * ```js
-     * const { Map } = require('immutable@4.0.0-rc.8')
+     * const { Map } = require('immutable@4.0.0-rc.9')
      * Map({ a: 1, b: 2, c: 3, d: 4}).filter(x => x % 2 === 0)
      * // Map { "b": 2, "d": 4 }
      * ```
@@ -4333,7 +4052,7 @@
      *
      * <!-- runkit:activate -->
      * ```js
-     * const { Map } = require('immutable@4.0.0-rc.8')
+     * const { Map } = require('immutable@4.0.0-rc.9')
      * Map({ a: 1, b: 2, c: 3, d: 4}).filterNot(x => x % 2 === 0)
      * // Map { "a": 1, "c": 3 }
      * ```
@@ -4370,7 +4089,7 @@
      *
      * <!-- runkit:activate -->
      * ```js
-     * const { Map } = require('immutable@4.0.0-rc.8')
+     * const { Map } = require('immutable@4.0.0-rc.9')
      * Map({ "c": 3, "a": 1, "b": 2 }).sort((a, b) => {
      *   if (a < b) { return -1; }
      *   if (a > b) { return 1; }
@@ -4410,7 +4129,7 @@
      *
      * <!-- runkit:activate -->
      * ```js
-     * const { List, Map } = require('immutable@4.0.0-rc.8')
+     * const { List, Map } = require('immutable@4.0.0-rc.9')
      * const listOfMaps = List([
      *   Map({ v: 0 }),
      *   Map({ v: 1 }),
@@ -4497,7 +4216,7 @@
      *
      * <!-- runkit:activate -->
      * ```js
-     * const { List } = require('immutable@4.0.0-rc.8')
+     * const { List } = require('immutable@4.0.0-rc.9')
      * List([ 'dog', 'frog', 'cat', 'hat', 'god' ])
      *   .skipWhile(x => x.match(/g/))
      * // List [ "cat", "hat", "god"" ]
@@ -4514,7 +4233,7 @@
      *
      * <!-- runkit:activate -->
      * ```js
-     * const { List } = require('immutable@4.0.0-rc.8')
+     * const { List } = require('immutable@4.0.0-rc.9')
      * List([ 'dog', 'frog', 'cat', 'hat', 'god' ])
      *   .skipUntil(x => x.match(/hat/))
      * // List [ "hat", "god"" ]
@@ -4543,7 +4262,7 @@
      *
      * <!-- runkit:activate -->
      * ```js
-     * const { List } = require('immutable@4.0.0-rc.8')
+     * const { List } = require('immutable@4.0.0-rc.9')
      * List([ 'dog', 'frog', 'cat', 'hat', 'god' ])
      *   .takeWhile(x => x.match(/o/))
      * // List [ "dog", "frog" ]
@@ -4560,7 +4279,7 @@
      *
      * <!-- runkit:activate -->
      * ```js
-     * const { List } = require('immutable@4.0.0-rc.8')
+     * const { List } = require('immutable@4.0.0-rc.9')
      * List([ 'dog', 'frog', 'cat', 'hat', 'god' ])
      *   .takeUntil(x => x.match(/at/))
      * // List [ "dog", "frog" ]
@@ -4779,82 +4498,361 @@
      */
     keyOf(searchValue: V): K | undefined;
 
-    /**
-     * Returns the last key associated with the search value, or undefined.
-     */
-    lastKeyOf(searchValue: V): K | undefined;
+    /**
+     * Returns the last key associated with the search value, or undefined.
+     */
+    lastKeyOf(searchValue: V): K | undefined;
+
+    /**
+     * Returns the maximum value in this collection. If any values are
+     * comparatively equivalent, the first one found will be returned.
+     *
+     * The `comparator` is used in the same way as `Collection#sort`. If it is not
+     * provided, the default comparator is `>`.
+     *
+     * When two values are considered equivalent, the first encountered will be
+     * returned. Otherwise, `max` will operate independent of the order of input
+     * as long as the comparator is commutative. The default comparator `>` is
+     * commutative *only* when types do not differ.
+     *
+     * If `comparator` returns 0 and either value is NaN, undefined, or null,
+     * that value will be returned.
+     */
+    max(comparator?: (valueA: V, valueB: V) => number): V | undefined;
+
+    /**
+     * Like `max`, but also accepts a `comparatorValueMapper` which allows for
+     * comparing by more sophisticated means:
+     *
+     *     hitters.maxBy(hitter => hitter.avgHits);
+     *
+     */
+    maxBy<C>(
+      comparatorValueMapper: (value: V, key: K, iter: this) => C,
+      comparator?: (valueA: C, valueB: C) => number
+    ): V | undefined;
+
+    /**
+     * Returns the minimum value in this collection. If any values are
+     * comparatively equivalent, the first one found will be returned.
+     *
+     * The `comparator` is used in the same way as `Collection#sort`. If it is not
+     * provided, the default comparator is `<`.
+     *
+     * When two values are considered equivalent, the first encountered will be
+     * returned. Otherwise, `min` will operate independent of the order of input
+     * as long as the comparator is commutative. The default comparator `<` is
+     * commutative *only* when types do not differ.
+     *
+     * If `comparator` returns 0 and either value is NaN, undefined, or null,
+     * that value will be returned.
+     */
+    min(comparator?: (valueA: V, valueB: V) => number): V | undefined;
+
+    /**
+     * Like `min`, but also accepts a `comparatorValueMapper` which allows for
+     * comparing by more sophisticated means:
+     *
+     *     hitters.minBy(hitter => hitter.avgHits);
+     *
+     */
+    minBy<C>(
+      comparatorValueMapper: (value: V, key: K, iter: this) => C,
+      comparator?: (valueA: C, valueB: C) => number
+    ): V | undefined;
+
+
+    // Comparison
+
+    /**
+     * True if `iter` includes every value in this Collection.
+     */
+    isSubset(iter: Iterable<V>): boolean;
+
+    /**
+     * True if this Collection includes every value in `iter`.
+     */
+    isSuperset(iter: Iterable<V>): boolean;
+  }
+
+  /**
+   * The interface to fulfill to qualify as a Value Object.
+   */
+  export interface ValueObject {
+    /**
+     * True if this and the other Collection have value equality, as defined
+     * by `Immutable.is()`.
+     *
+     * Note: This is equivalent to `Immutable.is(this, other)`, but provided to
+     * allow for chained expressions.
+     */
+    equals(other: any): boolean;
+
+    /**
+     * Computes and returns the hashed identity for this Collection.
+     *
+     * The `hashCode` of a Collection is used to determine potential equality,
+     * and is used when adding this to a `Set` or as a key in a `Map`, enabling
+     * lookup via a different instance.
+     *
+     * <!-- runkit:activate -->
+     * ```js
+     * const { List, Set } = require('immutable@4.0.0-rc.9');
+     * const a = List([ 1, 2, 3 ]);
+     * const b = List([ 1, 2, 3 ]);
+     * assert.notStrictEqual(a, b); // different instances
+     * const set = Set([ a ]);
+     * assert.equal(set.has(b), true);
+     * ```
+     *
+     * Note: hashCode() MUST return a Uint32 number. The easiest way to
+     * guarantee this is to return `myHash | 0` from a custom implementation.
+     *
+     * If two values have the same `hashCode`, they are [not guaranteed
+     * to be equal][Hash Collision]. If two values have different `hashCode`s,
+     * they must not be equal.
+     *
+     * Note: `hashCode()` is not guaranteed to always be called before
+     * `equals()`. Most but not all Immutable.js collections use hash codes to
+     * organize their internal data structures, while all Immutable.js
+     * collections use equality during lookups.
+     *
+     * [Hash Collision]: http://en.wikipedia.org/wiki/Collision_(computer_science)
+     */
+    hashCode(): number;
+  }
+
+  /**
+   * Deeply converts plain JS objects and arrays to Immutable Maps and Lists.
+   *
+   * If a `reviver` is optionally provided, it will be called with every
+   * collection as a Seq (beginning with the most nested collections
+   * and proceeding to the top-level collection itself), along with the key
+   * refering to each collection and the parent JS object provided as `this`.
+   * For the top level, object, the key will be `""`. This `reviver` is expected
+   * to return a new Immutable Collection, allowing for custom conversions from
+   * deep JS objects. Finally, a `path` is provided which is the sequence of
+   * keys to this value from the starting value.
+   *
+   * `reviver` acts similarly to the [same parameter in `JSON.parse`][1].
+   *
+   * If `reviver` is not provided, the default behavior will convert Objects
+   * into Maps and Arrays into Lists like so:
+   *
+   * <!-- runkit:activate -->
+   * ```js
+   * const { fromJS, isKeyed } = require('immutable@4.0.0-rc.9')
+   * function (key, value) {
+   *   return isKeyed(value) ? value.Map() : value.toList()
+   * }
+   * ```
+   *
+   * `fromJS` is conservative in its conversion. It will only convert
+   * arrays which pass `Array.isArray` to Lists, and only raw objects (no custom
+   * prototype) to Map.
+   *
+   * Accordingly, this example converts native JS data to OrderedMap and List:
+   *
+   * <!-- runkit:activate -->
+   * ```js
+   * const { fromJS, isKeyed } = require('immutable@4.0.0-rc.9')
+   * fromJS({ a: {b: [10, 20, 30]}, c: 40}, function (key, value, path) {
+   *   console.log(key, value, path)
+   *   return isKeyed(value) ? value.toOrderedMap() : value.toList()
+   * })
+   *
+   * > "b", [ 10, 20, 30 ], [ "a", "b" ]
+   * > "a", {b: [10, 20, 30]}, [ "a" ]
+   * > "", {a: {b: [10, 20, 30]}, c: 40}, []
+   * ```
+   *
+   * Keep in mind, when using JS objects to construct Immutable Maps, that
+   * JavaScript Object properties are always strings, even if written in a
+   * quote-less shorthand, while Immutable Maps accept keys of any type.
+   *
+   * <!-- runkit:activate -->
+   * ```js
+   * const { Map } = require('immutable@4.0.0-rc.9')
+   * let obj = { 1: "one" };
+   * Object.keys(obj); // [ "1" ]
+   * assert.equal(obj["1"], obj[1]); // "one" === "one"
+   *
+   * let map = Map(obj);
+   * assert.notEqual(map.get("1"), map.get(1)); // "one" !== undefined
+   * ```
+   *
+   * Property access for JavaScript Objects first converts the key to a string,
+   * but since Immutable Map keys can be of any type the argument to `get()` is
+   * not altered.
+   *
+   * [1]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/parse#Example.3A_Using_the_reviver_parameter
+   *      "Using the reviver parameter"
+   */
+  export function fromJS(
+    jsValue: any,
+    reviver?: (
+      key: string | number,
+      sequence: Collection.Keyed<string, any> | Collection.Indexed<any>,
+      path?: Array<string | number>
+    ) => any
+  ): any;
+
+  /**
+   * Value equality check with semantics similar to `Object.is`, but treats
+   * Immutable `Collection`s as values, equal if the second `Collection` includes
+   * equivalent values.
+   *
+   * It's used throughout Immutable when checking for equality, including `Map`
+   * key equality and `Set` membership.
+   *
+   * <!-- runkit:activate -->
+   * ```js
+   * const { Map, is } = require('immutable@4.0.0-rc.9')
+   * const map1 = Map({ a: 1, b: 1, c: 1 })
+   * const map2 = Map({ a: 1, b: 1, c: 1 })
+   * assert.equal(map1 !== map2, true)
+   * assert.equal(Object.is(map1, map2), false)
+   * assert.equal(is(map1, map2), true)
+   * ```
+   *
+   * `is()` compares primitive types like strings and numbers, Immutable.js
+   * collections like `Map` and `List`, but also any custom object which
+   * implements `ValueObject` by providing `equals()` and `hashCode()` methods.
+   *
+   * Note: Unlike `Object.is`, `Immutable.is` assumes `0` and `-0` are the same
+   * value, matching the behavior of ES6 Map key equality.
+   */
+  export function is(first: any, second: any): boolean;
 
-    /**
-     * Returns the maximum value in this collection. If any values are
-     * comparatively equivalent, the first one found will be returned.
-     *
-     * The `comparator` is used in the same way as `Collection#sort`. If it is not
-     * provided, the default comparator is `>`.
-     *
-     * When two values are considered equivalent, the first encountered will be
-     * returned. Otherwise, `max` will operate independent of the order of input
-     * as long as the comparator is commutative. The default comparator `>` is
-     * commutative *only* when types do not differ.
-     *
-     * If `comparator` returns 0 and either value is NaN, undefined, or null,
-     * that value will be returned.
-     */
-    max(comparator?: (valueA: V, valueB: V) => number): V | undefined;
+  /**
+   * The `hash()` function is an important part of how Immutable determines if
+   * two values are equivalent and is used to determine how to store those
+   * values. Provided with any value, `hash()` will return a 31-bit integer.
+   *
+   * When designing Objects which may be equal, it's important than when a
+   * `.equals()` method returns true, that both values `.hashCode()` method
+   * return the same value. `hash()` may be used to produce those values.
+   *
+   * For non-Immutable Objects that do not provide a `.hashCode()` functions
+   * (including plain Objects, plain Arrays, Date objects, etc), a unique hash
+   * value will be created for each *instance*. That is, the create hash
+   * represents referential equality, and not value equality for Objects. This
+   * ensures that if that Object is mutated over time that its hash code will
+   * remain consistent, allowing Objects to be used as keys and values in
+   * Immutable.js collections.
+   *
+   * Note that `hash()` attempts to balance between speed and avoiding
+   * collisions, however it makes no attempt to produce secure hashes.
+   *
+   * *New in Version 4.0*
+   */
+  export function hash(value: any): number;
 
-    /**
-     * Like `max`, but also accepts a `comparatorValueMapper` which allows for
-     * comparing by more sophisticated means:
-     *
-     *     hitters.maxBy(hitter => hitter.avgHits);
-     *
-     */
-    maxBy<C>(
-      comparatorValueMapper: (value: V, key: K, iter: this) => C,
-      comparator?: (valueA: C, valueB: C) => number
-    ): V | undefined;
+  /**
+   * True if `maybeImmutable` is an Immutable Collection or Record.
+   *
+   * Note: Still returns true even if the collections is within a `withMutations()`.
+   *
+   * <!-- runkit:activate -->
+   * ```js
+   * const { isImmutable, Map, List, Stack } = require('immutable@4.0.0-rc.9');
+   * isImmutable([]); // false
+   * isImmutable({}); // false
+   * isImmutable(Map()); // true
+   * isImmutable(List()); // true
+   * isImmutable(Stack()); // true
+   * isImmutable(Map().asMutable()); // true
+   * ```
+   */
+  export function isImmutable(maybeImmutable: any): maybeImmutable is Collection<any, any>;
 
-    /**
-     * Returns the minimum value in this collection. If any values are
-     * comparatively equivalent, the first one found will be returned.
-     *
-     * The `comparator` is used in the same way as `Collection#sort`. If it is not
-     * provided, the default comparator is `<`.
-     *
-     * When two values are considered equivalent, the first encountered will be
-     * returned. Otherwise, `min` will operate independent of the order of input
-     * as long as the comparator is commutative. The default comparator `<` is
-     * commutative *only* when types do not differ.
-     *
-     * If `comparator` returns 0 and either value is NaN, undefined, or null,
-     * that value will be returned.
-     */
-    min(comparator?: (valueA: V, valueB: V) => number): V | undefined;
+  /**
+   * True if `maybeCollection` is a Collection, or any of its subclasses.
+   *
+   * <!-- runkit:activate -->
+   * ```js
+   * const { isCollection, Map, List, Stack } = require('immutable@4.0.0-rc.9');
+   * isCollection([]); // false
+   * isCollection({}); // false
+   * isCollection(Map()); // true
+   * isCollection(List()); // true
+   * isCollection(Stack()); // true
+   * ```
+   */
+  export function isCollection(maybeCollection: any): maybeCollection is Collection<any, any>;
 
-    /**
-     * Like `min`, but also accepts a `comparatorValueMapper` which allows for
-     * comparing by more sophisticated means:
-     *
-     *     hitters.minBy(hitter => hitter.avgHits);
-     *
-     */
-    minBy<C>(
-      comparatorValueMapper: (value: V, key: K, iter: this) => C,
-      comparator?: (valueA: C, valueB: C) => number
-    ): V | undefined;
+  /**
+   * True if `maybeKeyed` is a Collection.Keyed, or any of its subclasses.
+   *
+   * <!-- runkit:activate -->
+   * ```js
+   * const { isKeyed, Map, List, Stack } = require('immutable@4.0.0-rc.9');
+   * isKeyed([]); // false
+   * isKeyed({}); // false
+   * isKeyed(Map()); // true
+   * isKeyed(List()); // false
+   * isKeyed(Stack()); // false
+   * ```
+   */
+  export function isKeyed(maybeKeyed: any): maybeKeyed is Collection.Keyed<any, any>;
 
+  /**
+   * True if `maybeIndexed` is a Collection.Indexed, or any of its subclasses.
+   *
+   * <!-- runkit:activate -->
+   * ```js
+   * const { isIndexed, Map, List, Stack, Set } = require('immutable@4.0.0-rc.9');
+   * isIndexed([]); // false
+   * isIndexed({}); // false
+   * isIndexed(Map()); // false
+   * isIndexed(List()); // true
+   * isIndexed(Stack()); // true
+   * isIndexed(Set()); // false
+   * ```
+   */
+  export function isIndexed(maybeIndexed: any): maybeIndexed is Collection.Indexed<any>;
 
-    // Comparison
+  /**
+   * True if `maybeAssociative` is either a Keyed or Indexed Collection.
+   *
+   * <!-- runkit:activate -->
+   * ```js
+   * const { isAssociative, Map, List, Stack, Set } = require('immutable@4.0.0-rc.9');
+   * isAssociative([]); // false
+   * isAssociative({}); // false
+   * isAssociative(Map()); // true
+   * isAssociative(List()); // true
+   * isAssociative(Stack()); // true
+   * isAssociative(Set()); // false
+   * ```
+   */
+  export function isAssociative(maybeAssociative: any): maybeAssociative is Collection.Keyed<any, any> | Collection.Indexed<any>;
 
-    /**
-     * True if `iter` includes every value in this Collection.
-     */
-    isSubset(iter: Iterable<V>): boolean;
+  /**
+   * True if `maybeOrdered` is a Collection where iteration order is well
+   * defined. True for Collection.Indexed as well as OrderedMap and OrderedSet.
+   *
+   * <!-- runkit:activate -->
+   * ```js
+   * const { isOrdered, Map, OrderedMap, List, Set } = require('immutable@4.0.0-rc.9');
+   * isOrdered([]); // false
+   * isOrdered({}); // false
+   * isOrdered(Map()); // false
+   * isOrdered(OrderedMap()); // true
+   * isOrdered(List()); // true
+   * isOrdered(Set()); // false
+   * ```
+   */
+  export function isOrdered(maybeOrdered: any): boolean;
 
-    /**
-     * True if this Collection includes every value in `iter`.
-     */
-    isSuperset(iter: Iterable<V>): boolean;
-  }
+  /**
+   * True if `maybeValue` is a JavaScript Object which has *both* `equals()`
+   * and `hashCode()` methods.
+   *
+   * Any two instances of *value objects* can be compared for value equality with
+   * `Immutable.is()` and can be used as keys in a `Map` or members in a `Set`.
+   */
+  export function isValueObject(maybeValue: any): maybeValue is ValueObject;
 
   /**
    * Returns the value within the provided collection associated with the
@@ -4865,7 +4863,7 @@
    *
    * <!-- runkit:activate -->
    * ```js
-   * const { get } = require('immutable@4.0.0-rc.8')
+   * const { get } = require('immutable@4.0.0-rc.9')
    * get([ 'dog', 'frog', 'cat' ], 2) // 'frog'
    * get({ x: 123, y: 456 }, 'x') // 123
    * get({ x: 123, y: 456 }, 'z', 'ifNotSet') // 'ifNotSet'
@@ -4889,14 +4887,14 @@
    *
    * <!-- runkit:activate -->
    * ```js
-   * const { has } = require('immutable@4.0.0-rc.8')
+   * const { has } = require('immutable@4.0.0-rc.9')
    * has([ 'dog', 'frog', 'cat' ], 2) // true
    * has([ 'dog', 'frog', 'cat' ], 5) // false
    * has({ x: 123, y: 456 }, 'x') // true
    * has({ x: 123, y: 456 }, 'z') // false
    * ```
    */
-  export function has(collection: Object, key: mixed): boolean;
+  export function has(collection: Object, key: any): boolean;
 
   /**
    * Returns a copy of the collection with the value at key removed.
@@ -4907,7 +4905,7 @@
    *
    * <!-- runkit:activate -->
    * ```js
-   * const { remove } = require('immutable@4.0.0-rc.8')
+   * const { remove } = require('immutable@4.0.0-rc.9')
    * const originalArray = [ 'dog', 'frog', 'cat' ]
    * remove(originalArray, 1) // [ 'dog', 'cat' ]
    * console.log(originalArray) // [ 'dog', 'frog', 'cat' ]
@@ -4917,10 +4915,10 @@
    * ```
    */
   export function remove<K, C extends Collection<K, any>>(collection: C, key: K): C;
-  export function remove<TProps, R extends Record<TProps>, K extends keyof TProps>(collection: C, key: K): C;
+  export function remove<TProps, C extends Record<TProps>, K extends keyof TProps>(collection: C, key: K): C;
   export function remove<C extends Array<any>>(collection: C, key: number): C;
-  export function remove<C, K extends keyof Obj>(collection: C, key: K): C;
-  export function remove<K, C extends {[key: string]: any}>(collection: C, key: K): C;
+  export function remove<C, K extends keyof C>(collection: C, key: K): C;
+  export function remove<C extends {[key: string]: any}, K extends keyof C>(collection: C, key: K): C;
 
   /**
    * Returns a copy of the collection with the value at key set to the provided
@@ -4932,7 +4930,7 @@
    *
    * <!-- runkit:activate -->
    * ```js
-   * const { set } = require('immutable@4.0.0-rc.8')
+   * const { set } = require('immutable@4.0.0-rc.9')
    * const originalArray = [ 'dog', 'frog', 'cat' ]
    * set(originalArray, 1, 'cow') // [ 'dog', 'cow', 'cat' ]
    * console.log(originalArray) // [ 'dog', 'frog', 'cat' ]
@@ -4957,7 +4955,7 @@
    *
    * <!-- runkit:activate -->
    * ```js
-   * const { update } = require('immutable@4.0.0-rc.8')
+   * const { update } = require('immutable@4.0.0-rc.9')
    * const originalArray = [ 'dog', 'frog', 'cat' ]
    * update(originalArray, 1, val => val.toUpperCase()) // [ 'dog', 'FROG', 'cat' ]
    * console.log(originalArray) // [ 'dog', 'frog', 'cat' ]
@@ -4971,11 +4969,11 @@
   export function update<TProps, C extends Record<TProps>, K extends keyof TProps>(record: C, key: K, updater: (value: TProps[K]) => TProps[K]): C;
   export function update<TProps, C extends Record<TProps>, K extends keyof TProps, NSV>(record: C, key: K, notSetValue: NSV, updater: (value: TProps[K] | NSV) => TProps[K]): C;
   export function update<V>(collection: Array<V>, key: number, updater: (value: V) => V): Array<V>;
-  export function update<V, NSV>(collection: Array<V>, key: number, notSetValue: NSV, updater: (value: V | NSV) => V): C;
+  export function update<V, NSV>(collection: Array<V>, key: number, notSetValue: NSV, updater: (value: V | NSV) => V): Array<V>;
   export function update<C, K extends keyof C>(object: C, key: K, updater: (value: C[K]) => C[K]): C;
   export function update<C, K extends keyof C, NSV>(object: C, key: K, notSetValue: NSV, updater: (value: C[K] | NSV) => C[K]): C;
-  export function update<V, C extends {[key: string]: V}>(collection: C, key: K, updater: (value: V) => V): {[key: string]: V};
-  export function update<V, C extends {[key: string]: V}, NSV>(collection: C, key: K, notSetValue: NSV, updater: (value: V | NSV) => V): {[key: string]: V};
+  export function update<V, C extends {[key: string]: V}, K extends keyof C>(collection: C, key: K, updater: (value: V) => V): {[key: string]: V};
+  export function update<V, C extends {[key: string]: V}, K extends keyof C, NSV>(collection: C, key: K, notSetValue: NSV, updater: (value: V | NSV) => V): {[key: string]: V};
 
   /**
    * Returns the value at the provided key path starting at the provided
@@ -4986,7 +4984,7 @@
    *
    * <!-- runkit:activate -->
    * ```js
-   * const { getIn } = require('immutable@4.0.0-rc.8')
+   * const { getIn } = require('immutable@4.0.0-rc.9')
    * getIn({ x: { y: { z: 123 }}}, ['x', 'y', 'z']) // 123
    * getIn({ x: { y: { z: 123 }}}, ['x', 'q', 'p'], 'ifNotSet') // 'ifNotSet'
    * ```
@@ -5001,7 +4999,7 @@
    *
    * <!-- runkit:activate -->
    * ```js
-   * const { hasIn } = require('immutable@4.0.0-rc.8')
+   * const { hasIn } = require('immutable@4.0.0-rc.9')
    * hasIn({ x: { y: { z: 123 }}}, ['x', 'y', 'z']) // true
    * hasIn({ x: { y: { z: 123 }}}, ['x', 'q', 'p']) // false
    * ```
@@ -5016,7 +5014,7 @@
    *
    * <!-- runkit:activate -->
    * ```js
-   * const { removeIn } = require('immutable@4.0.0-rc.8')
+   * const { removeIn } = require('immutable@4.0.0-rc.9')
    * const original = { x: { y: { z: 123 }}}
    * removeIn(original, ['x', 'y', 'z']) // { x: { y: {}}}
    * console.log(original) // { x: { y: { z: 123 }}}
@@ -5033,7 +5031,7 @@
    *
    * <!-- runkit:activate -->
    * ```js
-   * const { setIn } = require('immutable@4.0.0-rc.8')
+   * const { setIn } = require('immutable@4.0.0-rc.9')
    * const original = { x: { y: { z: 123 }}}
    * setIn(original, ['x', 'y', 'z'], 456) // { x: { y: { z: 456 }}}
    * console.log(original) // { x: { y: { z: 123 }}}
@@ -5050,7 +5048,7 @@
    *
    * <!-- runkit:activate -->
    * ```js
-   * const { setIn } = require('immutable@4.0.0-rc.8')
+   * const { setIn } = require('immutable@4.0.0-rc.9')
    * const original = { x: { y: { z: 123 }}}
    * setIn(original, ['x', 'y', 'z'], val => val * 6) // { x: { y: { z: 738 }}}
    * console.log(original) // { x: { y: { z: 123 }}}
@@ -5067,7 +5065,7 @@
    *
    * <!-- runkit:activate -->
    * ```js
-   * const { merge } = require('immutable@4.0.0-rc.8')
+   * const { merge } = require('immutable@4.0.0-rc.9')
    * const original = { x: 123, y: 456 }
    * merge(original, { y: 789, z: 'abc' }) // { x: 123, y: 789, z: 'abc' }
    * console.log(original) // { x: { y: { z: 123 }}}
@@ -5087,7 +5085,7 @@
    *
    * <!-- runkit:activate -->
    * ```js
-   * const { mergeWith } = require('immutable@4.0.0-rc.8')
+   * const { mergeWith } = require('immutable@4.0.0-rc.9')
    * const original = { x: 123, y: 456 }
    * mergeWith(
    *   (oldVal, newVal) => oldVal + newVal,
@@ -5112,7 +5110,7 @@
    *
    * <!-- runkit:activate -->
    * ```js
-   * const { merge } = require('immutable@4.0.0-rc.8')
+   * const { merge } = require('immutable@4.0.0-rc.9')
    * const original = { x: { y: 123 }}
    * merge(original, { x: { z: 456 }}) // { x: { y: 123, z: 456 }}
    * console.log(original) // { x: { y: 123 }}
@@ -5133,7 +5131,7 @@
    *
    * <!-- runkit:activate -->
    * ```js
-   * const { merge } = require('immutable@4.0.0-rc.8')
+   * const { merge } = require('immutable@4.0.0-rc.9')
    * const original = { x: { y: 123 }}
    * mergeDeepWith(
    *   (oldVal, newVal) => oldVal + newVal,
@@ -5144,7 +5142,7 @@
    * ```
    */
   export function mergeDeepWith<C>(
-    merger: (oldVal: any, newVal: any, key: any) => mixed,
+    merger: (oldVal: any, newVal: any, key: any) => any,
     collection: C,
     ...collections: Array<Iterable<any> | Iterable<[any, any]> | {[key: string]: any}>
   ): C;