Releases: immutable-js/immutable-js
v4.3.0
What's Changed
- TS:
update
method may returnundefined
by @jdeniau in #1933 - DOCS: wrong link in README by @BilderLoong in #1938
- Fix fromJS declaration for greater compatibility by @jdeniau in #1936
- Introduce Comparator and PairSorting by @giancosta86 in #1937
New Contributors
- @BilderLoong made their first contribution in #1938
- @giancosta86 made their first contribution in #1937
Full Changelog: v4.2.4...v4.3.0
v4.2.4
v4.2.3
v4.2.2
v4.2.1
v4.2.0
- Added a
partition
method to all containers #1916 by johnw42 - [TypeScript] Better type for toJS #1917 by jdeniau
- [TS Minor Break] tests are ran with TS > 4.5 only. It was tested with TS > 2.1 previously, but we want to level up TS types with recent features. TS 4.5 has been released more than one year before this release. If it does break your implementation (it might not), you should probably consider upgrading to the latest TS version.
v4.1.0
v4.0.0
Docs: https://immutable-js.com/docs/v4.0.0/
Full Changelog: v3.8.1...v4.0.0
Key changes
- New members have joined the team
- The project has been relicensed as MIT
- Better TypeScript and Flow type definitions
- A brand-new documentation lives at immutable-js.com and can show multiple versions
- Behavior of
merge
andmergeDeep
has changed Iterable
is renamed to Collection- Records no longer extend from Collections
- All collection types now implement the ES6 iterable protocol
- New methods:
Diff of changed API (click to expand)
+ Collection.[Symbol.iterator]
+ Collection.toJSON
+ Collection.update
+ Collection.Indexed.[Symbol.iterator]
+ Collection.Indexed.toJSON
+ Collection.Indexed.update
+ Collection.Indexed.zipAll
+ Collection.Keyed.[Symbol.iterator]
+ Collection.Keyed.toJSON
+ Collection.Keyed.update
+ Collection.Set.[Symbol.iterator]
+ Collection.Set.toJSON
+ Collection.Set.update
- Collection.size
- Collection.Indexed.size
- Collection.Keyed.size
- Collection.Set.size
+ List.[Symbol.iterator]
+ List.toJSON
+ List.wasAltered
+ List.zipAll
- List.mergeDeep
- List.mergeDeepWith
- List.mergeWith
+ Map.[Symbol.iterator]
+ Map.deleteAll
+ Map.toJSON
+ Map.wasAltered
+ OrderedMap.[Symbol.iterator]
+ OrderedMap.deleteAll
+ OrderedMap.toJSON
+ OrderedMap.wasAltered
+ OrderedSet.[Symbol.iterator]
+ OrderedSet.toJSON
+ OrderedSet.update
+ OrderedSet.wasAltered
+ OrderedSet.zip
+ OrderedSet.zipAll
+ OrderedSet.zipWith
+ Record.[Symbol.iterator]
+ Record.asImmutable
+ Record.asMutable
+ Record.clear
+ Record.delete
+ Record.deleteIn
+ Record.merge
+ Record.mergeDeep
+ Record.mergeDeepIn
+ Record.mergeDeepWith
+ Record.mergeIn
+ Record.mergeWith
+ Record.set
+ Record.setIn
+ Record.toJSON
+ Record.update
+ Record.updateIn
+ Record.wasAltered
+ Record.withMutations
+ Record.Factory.displayName
- Record.butLast
- Record.concat
- Record.count
- Record.countBy
- Record.entries
- Record.entrySeq
- Record.every
- Record.filter
- Record.filterNot
- Record.find
- Record.findEntry
- Record.findKey
- Record.findLast
- Record.findLastEntry
- Record.findLastKey
- Record.first
- Record.flatMap
- Record.flatten
- Record.flip
- Record.forEach
- Record.groupBy
- Record.includes
- Record.isEmpty
- Record.isSubset
- Record.isSuperset
- Record.join
- Record.keyOf
- Record.keySeq
- Record.keys
- Record.last
- Record.lastKeyOf
- Record.map
- Record.mapEntries
- Record.mapKeys
- Record.max
- Record.maxBy
- Record.min
- Record.minBy
- Record.reduce
- Record.reduceRight
- Record.rest
- Record.reverse
- Record.skip
- Record.skipLast
- Record.skipUntil
- Record.skipWhile
- Record.slice
- Record.some
- Record.sort
- Record.sortBy
- Record.take
- Record.takeLast
- Record.takeUntil
- Record.takeWhile
- Record.toArray
- Record.toIndexedSeq
- Record.toKeyedSeq
- Record.toList
- Record.toMap
- Record.toOrderedMap
- Record.toOrderedSet
- Record.toSet
- Record.toSetSeq
- Record.toStack
- Record.valueSeq
- Record.values
+ Seq.[Symbol.iterator]
+ Seq.toJSON
+ Seq.update
+ Seq.Indexed.[Symbol.iterator]
+ Seq.Indexed.toJSON
+ Seq.Indexed.update
+ Seq.Indexed.zipAll
+ Seq.Keyed.[Symbol.iterator]
+ Seq.Keyed.toJSON
+ Seq.Keyed.update
+ Seq.Set.[Symbol.iterator]
+ Seq.Set.toJSON
+ Seq.Set.update
+ Set.[Symbol.iterator]
+ Set.toJSON
+ Set.update
+ Set.wasAltered
+ Stack.[Symbol.iterator]
+ Stack.toJSON
+ Stack.update
+ Stack.wasAltered
+ Stack.zipAll
+ ValueObject.equals
+ ValueObject.hashCode
- Iterable.*
- Iterable.Indexed.*
- Iterable.Keyed.*
- Iterable.Set.*
Note for users of v4.0.0-rc.12
There were mostly bugfixes and improvements since RC 12. Upgrading should be painless for most users.
However, there is one breaking change: The behavior of merge
and mergeDeep
has changed. See below for details.
BREAKING
merge()
-
No longer use value-equality within
merge()
(#1391)This rectifies an inconsistent behavior between
x.merge(y)
andx.mergeDeep(y)
where merge would
use===
on leaf values to determine return-self optimizations, while mergeDeep would useis()
.
This improves consistency across the library and avoids a possible performance pitfall. -
No longer deeply coerce argument to merge() (#1339)
Previously, the argument provided to
merge()
was deeply converted to Immutable collections viafromJS()
.
This was the only function in the library which callsfromJS()
indirectly,
and it was surprising and made it difficult to understand what the result ofmerge()
would be.
Now, the value provided tomerge()
is only shallowly converted to an Immutable collection, similar to
related methods in the library. This may change the behavior of your calls tomerge()
.
mergeDeep()
-
Replace incompatible collections when merging nested data (#1840)
It will no longer merge lists of tuples into maps. For more information see
#1840 and the updatedmergeDeep()
documentation. -
Concat Lists when merging deeply (#1344)
Previously, calling
map.mergeDeep()
with a value containing aList
would replace the values in the
original List. This has always been confusing, and does not properly treatList
as a monoid.
Now,List.merge
is simply an alias forList.concat
, andmap.mergeDeep()
will concatenate deeply-found lists
instead of replacing them.
Seq
-
Remove IteratorSequence. Do not attempt to detect iterators in
Seq()
. (#1589)Iterables can still be provided to
Seq()
, and most Iterators are also
Iterables, so this change should not affect the vast majority of uses.
For more information, see PR #1589 -
Remove
Seq.of()
(#1311, #1310)This method has been removed since it cannot be correctly typed. It's recommended to convert
Seq.of(1, 2, 3)
toSeq([1, 2, 3])
.
isImmutable()
-
isImmutable()
now returns true for collections currently within awithMutations()
call. (#1374)Previously,
isImmutable()
did double-duty of both determining if a value was a Collection or Record
from this library as well as if it was outside awithMutations()
call.
This latter case caused confusion and was rarely used.
toArray()
-
KeyedCollection.toArray() returns array of tuples. (#1340)
Previously, calling
toArray()
on a keyed collection (inclMap
andOrderedMap
) would
discard keys and return an Array of values. This has always been confusing, and differs fromArray.from()
.
Now, callingtoArray()
on a keyed collection will return an Array of[key, value]
tuples, matching
the behavior ofArray.from()
.
concat()
-
list.concat()
now has a slightly more efficient implementation andmap.concat()
is an alias formap.merge()
. (#1373)In rare cases, this may affect use of
map.concat()
which expected slightly different behavior frommap.merge()
.
Collection, formerly Iterable
- The
Iterable
class has been renamed toCollection
, andisIterable()
has been renamed toisCollection()
.
Aliases with the existing names exist to make transitioning code easier.
Record
- Record is no longer an Immutable Collection type.
- Now
isCollection(myRecord)
returnsfalse
instead oftrue
. - The sequence API (such as
map
,filter
,forEach
) no longer exist on Records. delete()
andclear()
no longer exist on Records.
- Now
Other breaking changes
-
Potentially Breaking: Improve hash speed and avoid collision for common values (#1629)
Causes some hash values to change, which could impact the order of iteration of values in some Maps
(which are already advertised as unordered, but highlighting just to be safe) -
Node buffers no longer considered value-equal (#1437)
-
Plain Objects and Arrays are no longer considered opaque valu...
v4.0.0-rc.15
This is the last planned RC release before releasing a stable 4.0!! 🎉 🎉 🎉
BREAKING:
- Replace incompatible collections when merging nested data with
mergeDeep()
(#1840)- This means that
mergeDeep()
will no longer merge lists of tuples into maps. For more information see #1840 and the updatedmergeDeep()
documentation.
- This means that
New:
- Add "sideEffects: false" to package.json (#1661)
- Update Flow types to be compatible with the latest version (#1863)
- Use ES standard for iterator method reuse (#1867)
- Generalize
fromJS()
andSeq()
to support Sets (#1865)
Fixes:
4.0.0-rc.14
- Fixes some TypeScript issues (Map constructor, update function, mapEntries)
- Fix add zipall to orderedset
- Improve documentation