UNPKG

selenium-webdriver

Version:

The official WebDriver JavaScript bindings from the Selenium project

9 lines 7.43 kB
<!DOCTYPE html><meta charset="UTF-8"><meta http-equiv="Content-Language" content="en" /><title>selenium-webdriver/io</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/io</h1><a class="source" href="/Users/jleyba/Development/selenium2/build/javascript/node/selenium-webdriver/docs/source/io/index.js.src.html">code &raquo;</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="static-functions"><h2>Functions</h2><div class="wrap-details public"><div><details class="function"><summary><div><a class="source" href="source/io/index.js.src.html#l36">code &raquo;</a><span class="member"><a name="copy">copy</a> <span class="args">( src, dst )</span> &rArr; <code class="type">!promise.Promise.&lt;<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>&gt;</code></span></div><p>Copies one file to another.</summary><div class="info"><table><tbody><tr><th>Parameters<tr><td><dl><dt>src: <code class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code><dd>The source file.<dt>dst: <code class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code><dd>The destination file.</dl><tr><th>Returns<tr><td><dl>A promise for the copied file's path.</dl></table></div></details></div></div><div class="wrap-details public"><div><details class="function"><summary><div><a class="source" href="source/io/index.js.src.html#l64">code &raquo;</a><span class="member"><a name="copyDir">copyDir</a> <span class="args">( src, dst, opt_exclude )</span> &rArr; <code class="type">!promise.Promise.&lt;<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>&gt;</code></span></div><p>Recursively copies the contents of one directory to another.</summary><div class="info"><table><tbody><tr><th>Parameters<tr><td><dl><dt>src: <code class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code><dd>The source directory to copy.<dt>dst: <code class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code><dd>The directory to copy into.<dt>opt_exclude: <code class="type">(RegEx|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/Boolean">boolean</a>)=</code><dd>An exclusion filter as either a regex or predicate function. All files matching this filter will not be copied.</dl><tr><th>Returns<tr><td><dl>A promise for the destination directory's path once all files have been copied.</dl></table></div></details></div></div><div class="wrap-details public"><div><details class="function"><summary><div><a class="source" href="source/io/index.js.src.html#l112">code &raquo;</a><span class="member"><a name="exists">exists</a> <span class="args">( path )</span> &rArr; <code class="type">!promise.Promise.&lt;<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a>&gt;</code></span></div><p>Tests if a file path exists.</summary><div class="info"><table><tbody><tr><th>Parameters<tr><td><dl><dt>path: <code class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code><dd>The path to test.</dl><tr><th>Returns<tr><td><dl>A promise for whether the file exists.</dl></table></div></details></div></div><div class="wrap-details public"><div><details class="function"><summary><div><a class="source" href="source/io/index.js.src.html#l148">code &raquo;</a><span class="member"><a name="findInPath">findInPath</a> <span class="args">( file, opt_checkCwd )</span> &rArr; <code class="type">?<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code></span></div><p>Searches the <code >PATH</code> environment variable for the given file.</summary><div class="info"><table><tbody><tr><th>Parameters<tr><td><dl><dt>file: <code class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code><dd>The file to locate on the PATH.<dt>opt_checkCwd: <code class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a>=</code><dd>Whether to always start with the search with the current working directory, regardless of whether it is explicitly listed on the PATH.</dl><tr><th>Returns<tr><td><dl>Path to the located file, or <code >null</code> if it could not be found.</dl></table></div></details></div></div><div class="wrap-details public"><div><details class="function"><summary><div><a class="source" href="source/io/index.js.src.html#l124">code &raquo;</a><span class="member"><a name="tmpDir">tmpDir</a> <span class="args">( )</span> &rArr; <code class="type">!promise.Promise.&lt;<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>&gt;</code></span></div></summary><div class="info"><table><tbody><tr><th>Returns<tr><td><dl>A promise for the path to a temporary directory.</dl></table></div></details></div></div><div class="wrap-details public"><div><details class="function"><summary><div><a class="source" href="source/io/index.js.src.html#l134">code &raquo;</a><span class="member"><a name="tmpFile">tmpFile</a> <span class="args">( )</span> &rArr; <code class="type">!promise.Promise.&lt;<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>&gt;</code></span></div></summary><div class="info"><table><tbody><tr><th>Returns<tr><td><dl>A promise for the path to a temporary file.</dl></table></div></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>