selenium-webdriver
Version:
The official WebDriver JavaScript bindings from the Selenium project
15 lines • 13.6 kB
HTML
<meta charset="UTF-8"><meta http-equiv="Content-Language" content="en" /><title>goog.testing.asserts</title><link href="dossier.css" rel="stylesheet" type="text/css"><div id="main-wrapper"><input type="checkbox" id="sidenav-toggle" /><main><header><h1>Namespace goog.testing.asserts</h1><a class="source" href="source/lib/goog/testing/asserts.js.src.html#l15">code »</a></header><section></section><div id="visibility-controls"><b>Show:</b><label for="show-public"><span><input type="checkbox" id="show-public" checked/></span>Public</label><label for="show-protected"><span><input type="checkbox" id="show-protected"/></span>Protected</label><label for="show-private"><span><input type="checkbox" id="show-private"/></span>Private</label></div><section id="typedefs"><h2>Type Definitions</h2><div class="wrap-details public"><div><details><summary><div><a class="source" href="source/lib/goog/testing/asserts.js.src.html#l26">code »</a><a class="member" name="goog.testing.asserts.ArrayLike">goog.testing.asserts.ArrayLike</a> : <code class="type">(<a href="http://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Array">Array</a>|<a href="http://www.w3.org/TR/1998/REC-DOM-Level-1-19981001/level-one-core.html#ID-536297177">NodeList</a>|<a href="http://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Functions_and_function_scope/arguments">Arguments</a>|{length: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a>})</code></div><div>No description.</div></summary></details></div></div></section><section id="static-functions"><h2>Global Functions</h2><div class="wrap-details public"><div><details class="function"><summary><div><a class="source" href="source/lib/goog/testing/asserts.js.src.html#l493">code »</a><span class="member"><a name="goog.testing.asserts.callWithoutLogging">goog.testing.asserts.callWithoutLogging</a> <span class="args">( fn )</span></span></div><p>Runs a function in an environment where test failures are not logged. This is
useful for testing test code, where failures can be a normal part of a test.</summary><div class="info"><table><tbody><tr><th>Parameters<tr><td><dl><dt>fn: <code class="type">function(): void</code><dd>Function to run without logging failures.</dl></table></div></details></div></div><div class="wrap-details private"><div><details class="function"><summary><div><a class="source" href="source/lib/goog/testing/asserts.js.src.html#l1145">code »</a><span class="member"><a name="goog.testing.asserts.contains_">goog.testing.asserts.contains_</a> <span class="args">( container, contained )</span> ⇒ <code class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a></code></span></div><p>Tells whether the array contains the given element.</summary><div class="info"><table><tbody><tr><th>Parameters<tr><td><dl><dt>container: <code class="type"><a href="namespace_goog_testing_asserts.html#goog.testing.asserts.ArrayLike">goog.testing.asserts.ArrayLike</a></code><dd>The array to
find the element in.<dt>contained: <code class="type">*</code><dd>Element to find.</dl><tr><th>Returns<tr><td><dl>Whether the element is in the array.</dl></table></div></details></div></div><div class="wrap-details public"><div><details class="function"><summary><div><a class="source" href="source/lib/goog/testing/asserts.js.src.html#l538">code »</a><span class="member"><a name="goog.testing.asserts.findDifferences">goog.testing.asserts.findDifferences</a> <span class="args">( expected, actual, opt_equalityPredicate )</span> ⇒ <code class="type">?<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code></span></div><p>Determines if two items of any type match, and formulates an error message
if not.</summary><div class="info"><table><tbody><tr><th>Parameters<tr><td><dl><dt>expected: <code class="type">*</code><dd>Expected argument to match.<dt>actual: <code class="type">*</code><dd>Argument as a result of performing the test.<dt>opt_equalityPredicate: <code class="type">(function(<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>, *, *): ?<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>)=</code><dd>An optional
function that can be used to check equality of variables. It accepts 3
arguments: type-of-variables, var1, var2 (in that order) and returns an
error message if the variables are not equal,
goog.testing.asserts.EQUALITY_PREDICATE_VARS_ARE_EQUAL if the variables
are equal, or
goog.testing.asserts.EQUALITY_PREDICATE_CANT_PROCESS if the predicate
couldn't check the input variables. The function will be called only if
the types of var1 and var2 are identical.</dl><tr><th>Returns<tr><td><dl>Null on success, error message on failure.</dl></table></div></details></div></div><div class="wrap-details private"><div><details class="function"><summary><div><a class="source" href="source/lib/goog/testing/asserts.js.src.html#l186">code »</a><span class="member"><a name="goog.testing.asserts.getDefaultErrorMsg_">goog.testing.asserts.getDefaultErrorMsg_</a> <span class="args">( expected, actual )</span> ⇒ <code class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code></span></div></summary><div class="info"><table><tbody><tr><th>Parameters<tr><td><dl><dt>expected: <code class="type">*</code><dd>The expected value.<dt>actual: <code class="type">*</code><dd>The actual value.</dl><tr><th>Returns<tr><td><dl>A failure message of the values don't match.</dl></table></div></details></div></div><div class="wrap-details private"><div><details class="function"><summary><div><a class="source" href="source/lib/goog/testing/asserts.js.src.html#l1122">code »</a><span class="member"><a name="goog.testing.asserts.indexOf_">goog.testing.asserts.indexOf_</a> <span class="args">( container, contained )</span> ⇒ <code class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a></code></span></div><p>Finds the position of the first occurrence of an element in a container.</summary><div class="info"><table><tbody><tr><th>Parameters<tr><td><dl><dt>container: <code class="type"><a href="namespace_goog_testing_asserts.html#goog.testing.asserts.ArrayLike">goog.testing.asserts.ArrayLike</a></code><dd>The array to find the element in.<dt>contained: <code class="type">*</code><dd>Element to find.</dl><tr><th>Returns<tr><td><dl>Index of the first occurrence or -1 if not found.</dl></table></div></details></div></div><div class="wrap-details private"><div><details class="function"><summary><div><a class="source" href="source/lib/goog/testing/asserts.js.src.html#l1192">code »</a><span class="member"><a name="goog.testing.asserts.isArrayIndexProp_">goog.testing.asserts.isArrayIndexProp_</a> <span class="args">( prop )</span> ⇒ <code class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a></code></span></div><p>Helper function for assertObjectEquals.</summary><div class="info"><table><tbody><tr><th>Parameters<tr><td><dl><dt>prop: <code class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code><dd>A property name.</dl><tr><th>Returns<tr><td><dl>If the property name is an array index.</dl></table></div></details></div></div><div class="wrap-details private"><div><details class="function"><summary><div><a class="source" href="source/lib/goog/testing/asserts.js.src.html#l57">code »</a><span class="member"><a name="goog.testing.asserts.numberRoughEqualityPredicate_">goog.testing.asserts.numberRoughEqualityPredicate_</a> <span class="args">( var1, var2, tolerance )</span> ⇒ <code class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a></code></span></div><p>Compares equality of two numbers, allowing them to differ up to a given
tolerance.</summary><div class="info"><table><tbody><tr><th>Parameters<tr><td><dl><dt>var1: <code class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a></code><dd>A number.<dt>var2: <code class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a></code><dd>A number.<dt>tolerance: <code class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a></code><dd>the maximum allowed difference.</dl><tr><th>Returns<tr><td><dl>Whether the two variables are sufficiently close.</dl></table></div></details></div></div><div class="wrap-details public"><div><details class="function"><summary><div><a class="source" href="source/lib/goog/testing/asserts.js.src.html#l1181">code »</a><span class="member"><a name="goog.testing.asserts.raiseException">goog.testing.asserts.raiseException</a> <span class="args">( comment, opt_message )</span></span></div><p>Raises a JsUnit exception with the given comment.</summary><div class="info"><table><tbody><tr><th>Parameters<tr><td><dl><dt>comment: <code class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code><dd>A summary for the exception.<dt>opt_message: <code class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>=</code><dd>A description of the exception.</dl></table></div></details></div></div><div class="wrap-details private"><div><details class="function"><summary><div><a class="source" href="source/lib/goog/testing/asserts.js.src.html#l1105">code »</a><span class="member"><a name="goog.testing.asserts.toArray_">goog.testing.asserts.toArray_</a> <span class="args">( arrayLike )</span> ⇒ <code class="type">!<a href="http://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Array">Array</a></code></span></div><p>Converts an array like object to array or clones it if it's already array.</summary><div class="info"><table><tbody><tr><th>Parameters<tr><td><dl><dt>arrayLike: <code class="type"><a href="namespace_goog_testing_asserts.html#goog.testing.asserts.ArrayLike">goog.testing.asserts.ArrayLike</a></code><dd>The collection.</dl><tr><th>Returns<tr><td><dl>Copy of the collection as array.</dl></table></div></details></div></div></section><section id="static-properties"><h2>Global Properties</h2><div class="wrap-details public"><div><details><summary><div><a class="source" href="source/lib/goog/testing/asserts.js.src.html#l511">code »</a><span class="member"><a name="goog.testing.asserts.EQUALITY_PREDICATE_CANT_PROCESS">goog.testing.asserts.EQUALITY_PREDICATE_CANT_PROCESS</a> : <code class="type">?<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code></span></div><p>The return value of the equality predicate passed to findDifferences below,
in cases where the predicate can't test the input variables for equality.</summary></details></div></div><div class="wrap-details public"><div><details><summary><div><a class="source" href="source/lib/goog/testing/asserts.js.src.html#l519">code »</a><span class="member"><a name="goog.testing.asserts.EQUALITY_PREDICATE_VARS_ARE_EQUAL">goog.testing.asserts.EQUALITY_PREDICATE_VARS_ARE_EQUAL</a> : <code class="type">?<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code></span></div><p>The return value of the equality predicate passed to findDifferences below,
in cases where the input vriables are equal.</summary></details></div></div><div class="wrap-details private"><div><details><summary><div><a class="source" href="source/lib/goog/testing/asserts.js.src.html#l67">code »</a><span class="member"><a name="goog.testing.asserts.primitiveRoughEqualityPredicates_">goog.testing.asserts.primitiveRoughEqualityPredicates_</a> : <code class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a>.<<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>></code></span></div></summary></details></div></div></section></main><nav id="topnav"><div><div id="menubutton"><label for="sidenav-toggle">Menu</label></div><form id="searchbox"><div><input type="search" placeholder="Search" tabindex="1"></div></form></div></nav><nav id="sidenav"><input type="checkbox" id="sidenav-types-ctrl" /><input type="checkbox" id="sidenav-files-ctrl" /><input type="checkbox" id="sidenav-modules-ctrl" /><a id="sidenav-overview"><div><h4>Overview</h4></div></a><div id="sidenav-types"><label for="sidenav-types-ctrl"><h4>Types</h4></label><i>Loading</i></div><div id="sidenav-modules"><label for="sidenav-modules-ctrl"><h4>Modules</h4></label><i>Loading</i></div><div id="sidenav-files"><label for="sidenav-files-ctrl"><h4>Files</h4></label><i>Loading</i></div><a href="license.html"><div><h4>License</h4></div></a></nav><div id="push-footer"></div></div><footer><a href="https://github.com/jleyba/js-dossier">Generated by dossier</a></footer><script src="types.js"></script><script src="dossier.js"></script>