Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Disable ajax timeout docs #900

Merged
merged 1 commit into from
Aug 1, 2018
Merged

Disable ajax timeout docs #900

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions dev-docs/publisher-api-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,8 @@ Some methods were deprecated in Prebid 1.0. [Archived pre-1.0 documentation]({{s
* [.setConfig(options)](#module_pbjs.setConfig)
* [debugging](#setConfig-Debugging)
* [bidderTimeout](#setConfig-Bidder-Timeouts)
* [maxRequestsPerOrigin](#setConfig-Max-Requests-Per-Origin)
* [disableAjaxTimeout](#setConfig-Disable-Ajax-Timeout)
* [bidderOrder](#setConfig-Bidder-Order)
* [enableSendAllBids](#setConfig-Send-All-Bids)
* [publisherDomain](#setConfig-Publisher-Domain)
Expand Down Expand Up @@ -1065,6 +1067,7 @@ See below for usage examples.
+ [Debugging](#setConfig-Debugging)
+ [Bidder Timeouts](#setConfig-Bidder-Timeouts)
+ [Max Requests Per Origin](#setConfig-Max-Requests-Per-Origin)
+ [Disable Ajax Timeout](#setConfig-Disable-Ajax-Timeout)
+ [Turn on send all bids mode](#setConfig-Send-All-Bids)
+ [Set the order in which bidders are called](#setConfig-Bidder-Order)
+ [Set the publisher's domain](#setConfig-Publisher-Domain)
Expand Down Expand Up @@ -1123,6 +1126,16 @@ pbjs.setConfig({ maxRequestsPerOrigin: 6 });
pbjs.setConfig({ maxRequestsPerOrigin: 1 });
{% endhighlight %}

#### Disable Ajax Timeout

<a name="setConfig-Disable-Ajax-Timeout" />

Prebid core adds a timeout on XMLHttpRequest request to terminate the request once auction is timedout. Since Prebid is ignoring all the bids after timeout it does not make sense to continue the request after timeout. However, you have the option to disable this by using `disableAjaxTimeout`.

{% highlight js %}
pbjs.setConfig({ disableAjaxTimeout: true });
{% endhighlight %}

#### Send All Bids

<a name="setConfig-Send-All-Bids" />
Expand Down