From 150986e418da53c1adcb49634da240ff379afff6 Mon Sep 17 00:00:00 2001 From: Carlos Serrano Date: Mon, 24 Dec 2018 14:45:19 +0100 Subject: [PATCH] =?UTF-8?q?docs:=20=E2=9C=8F=EF=B8=8F=20better=20document?= =?UTF-8?q?=20hooks?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- src/runner/runWaterfall.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/runner/runWaterfall.js b/src/runner/runWaterfall.js index eac8b46c..9e04554f 100644 --- a/src/runner/runWaterfall.js +++ b/src/runner/runWaterfall.js @@ -152,7 +152,7 @@ const waterfall = async (fetchVastChain, placeholder, options, isCanceled) => { * Defaults to `true`. * @param {Object} [options.hooks] - Optional map with hooks to configure the behaviour of the ad. * @param {Function} [options.hooks.createSkipControl] - If provided it will be called to generate the skip control. Must return a clickable [HTMLElement](https://developer.mozilla.org/es/docs/Web/API/HTMLElement) that is detached from the DOM. - * @param {Function} [options.hooks.validateVastResponse] - If provided it will be called for each valid vast response. Must throw if there is a problem with the vast response. If the Error instance has an `errorCode` number then it will be tracked using the error macros in the Vast response. It will also call {@link runWaterfall~onError} with the thrown error. + * @param {Function} [options.hooks.validateVastResponse] - If provided it will be called for each valid vast response. Must throw if there is a problem with the vast response. If the Error instance has an `code` number then it will be tracked using the error macros in the Vast response. It will also call {@link runWaterfall~onError} with the thrown error. * @param {Function} [options.hooks.transformVastResponse] - If provided it will be called before building the adUnit allowing the modification of the vastResponse if needed. * @returns {Function} - Cancel function. If called it will cancel the ad run. {@link runWaterfall~onRunFinish} will still be called; */