add note about withCredentials default value in Migrating from 2.x to 3.0 #352
Description
I upgraded socket.io-client for TypeScript from v2 to v4 today and spent a little time noticing that the withCredentials option was added and that its default was false.
As far as I can tell from my investigation, withCredentials option was added in this PR:
socketio/engine.io-client#614
but the default value was true ( this.withCredentials = false !== opts.withCredentials; ). Most users would have been unaffected.
In this commit, socketio/engine.io-client@5f47a50
withCredentials option no longer had a default value. It meant that the default value was false.
This change happened between engine.io-client v3 and v4. So it is breaking change socket.io-client from v2 to v3. Please note about it in Migrating from 2.x to 3.0 or add a migration guide for each client.