selenium-webdriver

Version:

The official WebDriver JavaScript bindings from the Selenium project

18 lines • 4.98 kB

HTML

<!DOCTYPE html><meta charset="UTF-8"><meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1, maximum-scale=1, user-scalable=no"><meta http-equiv="Content-Language" content="en"><meta http-equiv="X-UA-Compatible" content="IE=edge"><title>CancellationError</title><link href="dossier.css" rel="stylesheet" type="text/css"><header><div><form><div><input type="search" placeholder="Search" tabindex="1"></div></form></div></header><main><article><div class="parentlink"><b>Namespace:</b> <a href="namespace_webdriver_promise.html">webdriver.promise</a></div><div class="codelink"><a href="source/lib/webdriver/promise.js.src.html#l108">View Source</a></div><h1>class CancellationError</h1><div class="tags"><span>final</span></div><pre class="inheritance"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error">Error</a> └ goog.debug.Error └ webdriver.promise.CancellationError</pre><p>Error used when the computation of a promise is cancelled.</p> <h3>new CancellationError(<wbr>opt_msg)</h3><div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>opt_msg<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>=</code><dd><p>The cancellation message.</p> </dl></div></div><h2>Instance Properties</h2><div id="description" class="property"><dl><dt>description<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code><dd><p>IE-only.</p> </dl></div><div id="fileName" class="property"><dl><dt>fileName<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code><dd><p>Mozilla-only</p> </dl></div><div id="lineNumber" class="property"><dl><dt>lineNumber<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a></code><dd><p>Mozilla-only.</p> </dl></div><div id="message" class="property"><dl><dt><a href="source/lib/goog/debug/error.js.src.html#l47">message</a><code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code><dd>No description.</dl></div><div id="name" class="property"><dl><dt><a href="source/lib/webdriver/promise.js.src.html#l112">name</a><code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code><dd>No description.</dl></div><div id="reportErrorToServer" class="property"><dl><dt><a href="source/lib/goog/debug/error.js.src.html#l57">reportErrorToServer</a><code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a></code><dd><p>Whether to report this error to the server. Setting this to false will cause the error reporter to not report the error back to the server, which can be useful if the client knows that the error has already been logged on the server.</p> </dl></div><div id="sourceURL" class="property"><dl><dt>sourceURL<code>?</code><dd><p>Doesn't seem to exist, but closure/debug.js references it.</p> </dl></div><div id="stack" class="property"><dl><dt><a href="source/lib/goog/debug/error.js.src.html#l42">stack</a><code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code><dd>No description.</dl></div><h2>Static Functions</h2><div id="CancellationError.wrap" class="function"><div><h3>CancellationError.wrap(<wbr>error, opt_msg)<span class="codelink"><a href="source/lib/webdriver/promise.js.src.html#l125">code »</a></span></h3><p>Wraps the given error in a CancellationError. Will trivially return the error itself if it is an instanceof CancellationError.</p> <div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>error<code>*</code><dd><p>The error to wrap.</p> <dt>opt_msg<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>=</code><dd><p>The prefix message to use.</p> </dl></div><div class="fn-details"><div><b>Returns</b></div><dl><dt><code><a href="class_webdriver_promise_CancellationError.html">webdriver.promise.CancellationError</a></code><dd><p>A cancellation error.</p> </dl></div></div></div></div></article><nav><h3><a href="index.html" tabindex="2">Overview</a></h3><div><input type="checkbox" id="nav-modules" checked/><label for="nav-modules"><h3><span class="selectable" tabindex="2">Modules</span></h3></label><div id="nav-modules-view"></div></div><div><input type="checkbox" id="nav-types" checked/><label for="nav-types"><h3><span class="selectable" tabindex="2">Types</span></h3></label><div id="nav-types-view"></div></div><h3><a href="Changes.html" tabindex="2">Changes</a></h3></nav></main><footer><div><a href="https://github.com/jleyba/js-dossier">Generated by dossier</a></div></footer><script src="types.js"></script><script src="dossier.js"></script>