Releases: immutable-js/immutable-js
v5.0.0-beta.5
What's Changed
Merge fixes from v4.3.5
v4.3.5
Contributors
Assets 2
5.0.0-beta.4
Revert tree-shaking possibility as it does break. Moreover, as nearly every collection type can be converted to another collection (Map().toList() for example), so nearly no code was removed.
I think that if we want to implement this, we might need to rethink this functionality.
5.0.0-beta.2
Merge main branch into 5.x for 4.3.4 fixes.
4.3.4
5.0.0-beta.1
[Minor BC break] Reducing file size / tree shaking
Immutable does not export a default object containing all it's API anymore.
It changes the output of your JS file if you use a bundler that supports tree-shaking (all modern bundler do).
As a drawback, you can not immport Immutable directly:
- import Immutable from 'immutable';
+ import { List, Map } from 'immutable';
- const l = Immutable.List([Immutable.Map({ a: 'A' })]);
+ const l = List([Map({ a: 'A' })]);If you want the non-recommanded, but shorter migration path, you can do this:
- import Immutable from 'immutable';
+ import * as Immutable from 'immutable';
const l = Immutable.List([Immutable.Map({ a: 'A' })]);[TypeScript Break] Improve TypeScript definition for Map
If you do not use TypeScript, then this change does not impact you : no runtime change here.
But if you use Map with TypeScript, this is a HUGE change !
Imagine the following code
const m = Map({ length: 3, 1: 'one' });This was previously typed as Map<string, string | number>
and return type of m.get('length') or m.get('inexistant') was typed as string | number | undefined.
This made Map really unusable with TypeScript.
Now the Map is typed like this:
MapOf<{
length: number;
1: string;
}>and the return type of m.get('length') is typed as number.
The return of m.get('inexistant') throw the TypeScript error:
Argument of type '"inexistant"' is not assignable to parameter of type '1 | "length"
If you want to keep the old definition
This is a minor BC for TS users, so if you want to keep the old definition, you can declare you Map like this:
const m = Map<string, string | number>({ length: 3, 1: 'one' });If you need to type the Map with a larger definition
You might want to declare a wider definition, you can type your Map like this:
type MyMapType = {
length: number;
1: string | null;
optionalProperty?: string;
};
const m = Map<MyMapType>({ length: 3, 1: 'one' });Keep in mind that the MapOf will try to be consistant with the simple TypeScript object, so you can not do this:
Map({ a: 'a' }).set('b', 'b');
Map({ a: 'a' }).delete('a');Like a simple object, it will only work if the type is forced:
Map<{ a: string; b?: string }>({ a: 'a' }).set('b', 'b'); // b is forced in type and optional
Map<{ a?: string }>({ a: 'a' }).delete('a'); // you can only delete an optional keyAre all Map methods implemented ?
For now, only get, getIn, set, update, delete, remove, toJS, toJSON methods are implemented. All other methods will fallback to the basic Map definition. Other method definition will be added later, but as some might be really complex, we prefer the progressive enhancement on the most used functions.
v4.3.3
What's Changed
- [typescript] manage to handle toJS circular reference. #1932 by @jdeniau
- [doc] Add install instructions for pnpm and Bun #1952 by @colinhacks and #1953 by @menglingyu659
New Contributors
- @colinhacks made their first contribution in #1952
- @menglingyu659 made their first contribution in #1953
Full Changelog: v4.3.1...v4.3.3
Contributors
Assets 2
v4.3.2
v4.3.1
v4.3.0
What's Changed
- TS:
updatemethod may returnundefinedby @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
