Builder

Builder

new Builder(configuration)

Parameters:
Name Type Description
configuration
Source:

Methods

setAdsBlocking(blockFlag)

Sets if ads will be blocked for the current request
Parameters:
Name Type Description
blockFlag Boolean
Source:

setApiKey(apiKey)

Sets the api key of the current request instance
Parameters:
Name Type Description
apiKey String The api key that will be used to perform the requests
Source:

setCookies(cookies)

Sets the cookies to be forwarded with the request
Parameters:
Name Type Description
cookies Array.<Object> | null The cookies that will be forwarded to the request. If null is passed cookies will be reset to an empty array.
Properties
Name Type Description
name String
value String
Source:

setCountryCode(countryCode)

Sets the country of the proxy that will perform the request
Parameters:
Name Type Description
countryCode String
Source:

setCssWaitForSelector(selector)

Sets a selector which the browser must wait to be visible before returning the webpage code.
Parameters:
Name Type Description
selector String
Source:

setHeaders(cookies)

Sets the headers to be forwarded with the request
Parameters:
Name Type Description
cookies Array.<Object> | null The headers that will be forwarded to the request. If null is passed headers will be reset to an empty array.
headers[].name String
headers[].value String
Source:

setJavascriptRendering(renderFlag)

Sets if the javascript that the requested page contains will be rendered or not
Parameters:
Name Type Description
renderFlag Boolean
Source:

setJavascriptSnippet(snippet)

Sets a javascript snippet that will be executed after the requested page has completed loading
Parameters:
Name Type Description
snippet String | null
Source:

setJavascriptWaitForLoad(wait)

Sets how much time the browser will wait for the page to load completely before returning the webpage code. Useful if the webpage performs async actions and the browser must wait for extra time, after the loaded event has been triggered. Time is passed in ms.
Parameters:
Name Type Description
wait Number
Source:

setPremiumProxy(premiumFlag)

Sets if a premium proxy will be used
Parameters:
Name Type Description
premiumFlag Boolean
Source:

setResourcesBlocking(blockFlag)

Sets if resources will be blocked (images and css)
Parameters:
Name Type Description
blockFlag Boolean
Source:

Builder

new Builder(configuration)

Parameters:
Name Type Description
configuration Object
Source:

Methods

setAdsBlocking(blockFlag)

Sets if ads will be blocked for the current request
Parameters:
Name Type Description
blockFlag Boolean
Source:

setApiKey(apiKey)

Sets the api key of the current request instance
Parameters:
Name Type Description
apiKey String The api key that will be used to perform the requests
Source:

setCookies(cookies)

Sets the cookies to be forwarded with the request
Parameters:
Name Type Description
cookies Array.<Object> | null The cookies that will be forwarded to the request. If null is passed cookies will be reset to an empty array.
Properties
Name Type Description
name String
value String
Source:

setCountryCode(countryCode)

Sets the country of the proxy that will perform the request
Parameters:
Name Type Description
countryCode String
Source:

setCssWaitForSelector(selector)

Sets a selector which the browser must wait to be visible before returning the webpage code.
Parameters:
Name Type Description
selector String
Source:

setHeaders(cookies)

Sets the headers to be forwarded with the request
Parameters:
Name Type Description
cookies Array.<Object> | null The headers that will be forwarded to the request. If null is passed headers will be reset to an empty array.
headers[].name String
headers[].value String
Source:

setJavascriptRendering(renderFlag)

Sets if the javascript that the requested page contains will be rendered or not
Parameters:
Name Type Description
renderFlag Boolean
Source:

setJavascriptSnippet(snippet)

Sets a javascript snippet that will be executed after the requested page has completed loading
Parameters:
Name Type Description
snippet String | null
Source:

setJavascriptWaitForLoad(wait)

Sets how much time the browser will wait for the page to load completely before returning the webpage code. Useful if the webpage performs async actions and the browser must wait for extra time, after the loaded event has been triggered. Time is passed in ms.
Parameters:
Name Type Description
wait Number
Source:

setPremiumProxy(premiumFlag)

Sets if a premium proxy will be used
Parameters:
Name Type Description
premiumFlag Boolean
Source:

setResourcesBlocking(blockFlag)

Sets if resources will be blocked (images and css)
Parameters:
Name Type Description
blockFlag Boolean
Source: