jquery-migrate
jquery-migrate copied to clipboard
Migrate error from within jQuery when using $.serialize with $.ajaxSettings.traditional
My site uses $.ajaxSettings.traditional = true, and we're working on upgrading to jQuery 3 now. The migrate script is showing a warning when I use $('form').serialize() because the implementation within jQuery uses param without checking the value of the traditional flag.
jQuery.fn.extend( {
serialize: function() {
return jQuery.param( this.serializeArray() );
},
...
})
(from serialize.js line 99-ish)
I was able to fix the warning by replacing $('form').serialize() with $.param( $('form').serializeArray() , $.ajaxSettings.traditional ), but I'm wondering for future users if it wouldn't be helpful to either:
- Update the migrate documentation to suggest this fix (other programmers might have a hard time understanding what the problem is, since the migrate documentation doesn't reference
serializeanywhere; I was confused for a bit before I realized that the offending code was within jQuery), or - modify the jQuery source to explicitly use the
traditionalflag in theserializeimplementation:Query.fn.extend( { serialize: function() { return jQuery.param( this.serializeArray(), jQuery.ajaxSettings.traditional ); }, ... )
Happy to PR if either of those is desirable.
We can't do the second thing, that would re-introduce the dependency we want to avoid.
What if we filled jQuery.fn.serialize inside Migrate and show a warning if jQuery.ajaxSettings.traditional is true?