Add API documentation to OrderedMap.set() (immutable-js#1492)

amiiit · kozlitinaelja · commit 72e5fbca0098 · 2018-05-15T12:30:48.000-04:00
diff --git a/type-definitions/Immutable.d.ts b/type-definitions/Immutable.d.ts
@@ -1429,6 +1429,27 @@ declare module Immutable {
      */
     readonly size: number;
 
+    /**
+     * Returns a new OrderedMap also containing the new key, value pair. If an equivalent
+     * key already exists in this OrderedMap, it will be replaced while maintaining the
+     * existing order.
+     *
+     * <!-- runkit:activate -->
+     * ```js
+     * const { OrderedMapMap } = require('immutable')
+     * const originalMap = Immutable.OrderedMap({a:1, b:1, c:1})
+     * const updatedMap = originalMap.set('b', 2)
+     *
+     * originalMap
+     * // OrderedMap {a: 1, b: 1, c: 1}
+     * updatedMap
+     * // OrderedMap {a: 1, b: 2, c: 1}
+     * ```
+     *
+     * Note: `set` can be used in `withMutations`.
+     */
+    set(key: K, value: V): this;
+
     /**
      * Returns a new OrderedMap resulting from merging the provided Collections
      * (or JS objects) into this OrderedMap. In other words, this takes each
