selenium-webdriver
Version:
The official WebDriver JavaScript bindings from the Selenium project
14 lines (12 loc) • 5.55 kB
HTML
<meta charset="UTF-8"><meta http-equiv="Content-Language" content="en" /><title>selenium-webdriver/_base</title><link href="dossier.css" rel="stylesheet" type="text/css"><div id="main-wrapper"><input type="checkbox" id="sidenav-toggle" /><main><header><h1>Module selenium-webdriver/_base</h1><a class="source" href="/usr/local/google/home/jleyba/dev/selenium/build/javascript/node/selenium-webdriver/docs/source/_base.js.src.html">code »</a></header><section><p>The base module responsible for bootstrapping the Closure
library and providing a means of loading Closure-based modules.
<p>Each script loaded by this module will be granted access to this module's
<code >require</code> function; all required non-native modules must be specified
relative to <em>this</em> module.
<p>This module will load all scripts from the "lib" subdirectory, unless the
SELENIUM_DEV_MODE environment variable has been set to 1, in which case all
scripts will be loaded from the Selenium client containing this script.</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="static-functions"><h2>Functions</h2><div class="wrap-details public"><div><details class="function"><summary><div><a class="source" href="source/_base.js.src.html#l144">code »</a><span class="member"><a name="exportPublicApi">exportPublicApi</a> <span class="args">( symbol )</span> ⇒ <code class="type">!<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a></code></span></div><p>Loads a symbol by name from the protected Closure context and exports its
public API to the provided object. This function relies on Closure code
conventions to define the public API of an object as those properties whose
name does not end with "_".</summary><div class="info"><table><tbody><tr><th>Parameters<tr><td><dl><dt>symbol: <code class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code><dd>The symbol to load. This must resolve to an object.</dl><tr><th>Returns<tr><td><dl>An object with the exported API.</dl><tr><th>Throws<tr><td><dl><dt><code class="type"><a href="http://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Error">Error</a></code><dd>If the symbol has not been defined or does not resolve to
an object.</dl></table></div></details></div></div><div class="wrap-details public"><div><details class="function"><summary><div><a class="source" href="source/_base.js.src.html#l164">code »</a><span class="member"><a name="isDevMode">isDevMode</a> <span class="args">( )</span> ⇒ <code class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a></code></span></div></summary><div class="info"><table><tbody><tr><th>Returns<tr><td><dl>Whether this script was loaded in dev mode.</dl></table></div></details></div></div><div class="wrap-details public"><div><details class="function"><summary><div><a class="source" href="source/_base.js.src.html#l165">code »</a><span class="member"><a name="require">require</a> <span class="args">( symbol )</span></span></div><p>Loads a symbol by name from the protected Closure context.</summary><div class="info"><table><tbody><tr><th>Parameters<tr><td><dl><dt>symbol: <code class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code><dd>The symbol to load.</dl><tr><th>Returns<tr><td><dl>The loaded symbol, or <code >null</code> if not found.</dl><tr><th>Throws<tr><td><dl><dt><code class="type"><a href="http://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Error">Error</a></code><dd>If the symbol has not been defined.</dl></table></div></details></div></div></section><section id="static-properties"><h2>Properties</h2><div class="wrap-details public"><div><details><summary><div><a class="source" href="source/_base.js.src.html#l162">code »</a><span class="member"><a name="closure">closure</a> : <code class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</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>No data</i></div><div id="sidenav-modules"><label for="sidenav-modules-ctrl"><h4>Modules</h4></label><i>No data</i></div><div id="sidenav-files"><label for="sidenav-files-ctrl"><h4>Files</h4></label><i>No data</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>