Adding onTimeout function in Adapter Spec

[vedantseta]

Type of change

• Feature
• Does this change affect user-facing APIs or examples documented on http://prebid.org?

Description of change

This adds a function onTimeout to bidder spec, letting bidders to subscribe to their own timeout.

Payload received to this function is same as bidTimeout event with timeout value and user configured params for this adunit and bidder combination.

However the payload contains timed out bids for subscribed bidder, unlike bidTimeout event data.

Example

export const spec = {
        code: BIDDER_CODE,
        aliases: ['ex'], // short code
        isBidRequestValid: function(bid) {
            return !!(bid.params.placementId || (bid.params.member && bid.params.invCode));
        },
        onTimeout: function(data) {
             // BIDDER SPEFIC CODE HERE

        },
}

Other information

This resolves #2254
Documentation PR : prebid.github.io/pull/678

[matthewlane]

@vedantseta Thanks a lot for the PR. We're going to need docs for the changes and an additional review since this changes core modules, but one change initially requested:

[matthewlane]

The way for...of loops transpile have caused us errors for the browsers we support, can you change this to a forEach or different looping construct?

[vedantseta]

@matthewlane , Have changed for..of to forEach and have added documentation prebid.github.io#678 here. Can you please review the same?

[matthewlane]

There's a conflict that needs resolving but otherwise looks good to me

[mkendall07]

it's really hard to visualize what this object looks like. Can you add it to the jsdocs typedef here?

[vedantseta]

return type is Array of Objects,

const adUnits = [{
      code: 'adUnit1',
      bids: [{
        bidder: 'bidder1',
        params: {
          key1: 'value1'
        }
      }]
    }];

In this case object is adUnits[0].params, which is defined by user

[mkendall07]

typedef would be nice here for the passed object.