Callback definition accuracy

[desandro]

Callback definition accuracy

[darsain]

Actually no. The always method doesn't receive any arguments. That's its nature as specified in the Deferred promise API specification. To get the simple callback functionality while binding deferred methods with an object map, you can pass the callback as a callback property. Here is the object map with all possible properties and arguments they receive:

$(selector).imagesLoaded({
    done: function ($images) {},
    fail: function ($images, $proper, $broken) {},
    always: function () {},
    progress: function (isBroken, $images, $proper, $broken) {},
    callback: function ($images, $proper, $broken) {} // here is the simple callback simulation
});

And it is all documented :)

[biphobe]

I still don't agree that it's all documented ;)

"Always" will be always executed no matter what happens with images - but what about standard callback? Will it be executed when all images fail to load? Or when something goes wrong?

Documentation states that callback function will be called when all images finish loading - but it hasn't been said what happens when images fail to load.

[darsain]

Yes, "when all images has finished with loading". There is purposely nothing about their state, as that is irrelevant in simple callback. The images state has effect only on Deferred promise resolution, which is mentioned later in the docs as a bonus feature.

If nothing else, the callback arguments itself suggest that it is triggered regardless of the state of final images. Otherwise what would be the point of having $proper & $broken arrays when callback doesn't fire if there are broken images :)

But I see where the source of confusion might be. I'll try to clarify that.

[biphobe]

That's exactly what I meant, sorry for confusion - thanks!