{ "name": "wd", "description": "WebDriver/Selenium 2 node.js client", "tags": [ "web", "automation", "browser", "javascript" ], "version": "0.0.32", "author": { "name": "Adam Christian", "email": "adam.christian@gmail.com" }, "repository": { "type": "git", "url": "https://github.com/admc/wd.git" }, "bugs": { "url": "https://github.com/admc/wd/issues" }, "engines": [ "node" ], "main": "./lib/main", "bin": { "wd": "./lib/bin.js" }, "directories": { "lib": "./lib" }, "dependencies": { "async": "0.2.x", "underscore": "1.4.x", "vargs": "~0.1.0", "q": "0.9.x", "request": "~2.21.0" }, "devDependencies": { "mocha": "1.9.x", "should": "1.2.x", "nock": "~0.17.5", "coffee-script": "1.6.x", "express": "3.x", "imageinfo": "1.0.x", "covershot": "0.1.x", "dox": "0.4.x", "mu2": "0.5.x", "sv-selenium": "0.1.x", "colors": "~0.6.0-1" }, "scripts": { "test": "make test_saucelabs" }, "readme": "# WD.js -- WebDriver/Selenium 2 for node.js\n\n[![Build Status](https://secure.travis-ci.org/admc/wd.png?branch=master)](http://travis-ci.org/admc/wd)\n[![Selenium Test Status](https://saucelabs.com/buildstatus/wdjs)](https://saucelabs.com/u/wdjs)\n\n## Update node to latest\n\nhttp://nodejs.org/#download\n\n## Install\n\n
\nnpm install wd\n
\n\n## Authors\n\n - Adam Christian ([admc](http://github.com/admc))\n - Ruben Daniels ([javruben](https://github.com/javruben))\n - Peter Braden ([peterbraden](https://github.com/peterbraden))\n - Seb Vincent ([sebv](https://github.com/sebv))\n - Peter 'Pita' Martischka ([pita](https://github.com/Pita))\n - Jonathan Lipps ([jlipps](https://github.com/jlipps))\n - Phil Sarin ([pdsarin](https://github.com/pdsarin))\n - Mathieu Sabourin ([OniOni](https://github.com/OniOni))\n - Bjorn Tipling ([btipling](https://github.com/btipling))\n - Santiago Suarez Ordonez ([santiycr](https://github.com/santiycr))\n - Bernard Kobos ([bernii](https://github.com/bernii))\n - Jason Carr ([maudineormsby](https://github.com/maudineormsby))\n\n## License\n\n * License - Apache 2: http://www.apache.org/licenses/LICENSE-2.0\n\n## Usage\n\n
\n): wd shell\n> x = wd.remote() or wd.remote(\"ondemand.saucelabs.com\", 80, \"username\", \"apikey\")\n\n> x.init() or x.init({desired capabilities ovveride})\n> x.get(\"http://www.url.com\")\n> x.eval(\"window.location.href\", function(e, o) { console.log(o) })\n> x.quit()\n
\n\n\n## Writing a test!\n\n
\nvar wd = require('wd')\n  , assert = require('assert')\n  , colors = require('colors')\n  , browser = wd.remote();\n\nbrowser.on('status', function(info) {\n  console.log(info.cyan);\n});\n\nbrowser.on('command', function(meth, path, data) {\n  console.log(' > ' + meth.yellow, path.grey, data || '');\n});\n\nbrowser.init({\n    browserName:'chrome'\n    , tags : [\"examples\"]\n    , name: \"This is an example test\"\n  }, function() {\n\n  browser.get(\"http://admc.io/wd/test-pages/guinea-pig.html\", function() {\n    browser.title(function(err, title) {\n      assert.ok(~title.indexOf('I am a page title - Sauce Labs'), 'Wrong title!');\n      browser.elementById('i am a link', function(err, el) {\n        browser.clickElement(el, function() {\n          browser.eval(\"window.location.href\", function(err, href) {\n            assert.ok(~href.indexOf('guinea-pig2'));\n            browser.quit();\n          });\n        });\n      });\n    });\n  });\n});\n
\n\n## Promises Api\n\nA promise api using [q](https://github.com/kriskowal/q) is\navailable. Code sample is\n[here](https://github.com/admc/wd/blob/master/examples/example.promise.chrome.js).\n\n## Chain Api\n\nA chain api is also available. Code sample is [here](https://github.com/admc/wd/blob/master/examples/example.chain.chrome.js).\n\n### Injecting command to the chain\n\nAs [queue](https://github.com/caolan/async#queue) implementation that we're using has some limitations, a special helper method *next* was added. It allows you to inject new calls to the execution chain inside callbacks.\n\n#### Example 1 - the problem\n\n```javascript\nbrowser\n .chain()\n // ...\n .elementById('i am a link', function(err, el) {\n // following call will be executed apart from the current execution chain\n // you won't be able to pass results further in chain\n // and it may cause racing codnitions in your script\n browser.clickElement(el, function() {\n console.log(\"did the click!\");\n });\n })\n // ...\n```\n\n#### Example 2 - solution, use *next*\n\n```javascript\nbrowser\n .chain()\n // ...\n .elementById('i am a link', function(err, el) {\n // call to clickElement will be injected to the queue\n // and will be executed sequentially after current function finishes\n browser.next('clickElement', el, function() {\n console.log(\"did the click!\");\n });\n })\n // ...\n```\n## Supported Methods\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
\nJsonWireProtocol\n\nwd\n
\nGET /status
\nQuery the server's current status.\n		\nstatus(cb) -> cb(err, status)
\n
\nPOST /session
\nCreate a new session.\n		\ninit(desired, cb) -> cb(err, sessionID)
\nInitialize the browser.
\n
\nGET /sessions
\nReturns a list of the currently active sessions.\n		\n

\nsessions(cb) -> cb(err, sessions)
\n

\n

\n## Alternate strategy to get session capabilities from server session list
\naltSessionCapabilities(cb) -> cb(err, capabilities)
\n

\n
\nGET /session/:sessionId
\nRetrieve the capabilities of the specified session.\n		\nsessionCapabilities(cb) -> cb(err, capabilities)
\n
\nDELETE /session/:sessionId
\nDelete the session.\n		\nquit(cb) -> cb(err)
\nDestroy the browser.
\n
\nPOST /session/:sessionId/timeouts
\nConfigure the amount of time that a particular type of operation can execute for before they are aborted and a |Timeout| error is returned to the client.\n		\nsetPageLoadTimeout(ms, cb) -> cb(err)
\n(use setImplicitWaitTimeout and setAsyncScriptTimeout to set the other timeouts)
\n
\nPOST /session/:sessionId/timeouts/async_script
\nSet the amount of time, in milliseconds, that asynchronous scripts executed by /session/:sessionId/execute_async are permitted to run before they are aborted and a |Timeout| error is returned to the client.\n		\nsetAsyncScriptTimeout(ms, cb) -> cb(err)
\n
\nPOST /session/:sessionId/timeouts/implicit_wait
\nSet the amount of time the driver should wait when searching for elements.\n		\nsetImplicitWaitTimeout(ms, cb) -> cb(err)
\n
\nGET /session/:sessionId/window_handle
\nRetrieve the current window handle.\n		\nwindowHandle(cb) -> cb(err, handle)
\n
\nGET /session/:sessionId/window_handles
\nRetrieve the list of all window handles available to the session.\n		\nwindowHandles(cb) -> cb(err, arrayOfHandles)
\n
\nGET /session/:sessionId/url
\nRetrieve the URL of the current page.\n		\nurl(cb) -> cb(err, url)
\n
\nPOST /session/:sessionId/url
\nNavigate to a new URL.\n		\nget(url,cb) -> cb(err)
\nGet a new url.
\n
\nPOST /session/:sessionId/forward
\nNavigate forwards in the browser history, if possible.\n		\nforward(cb) -> cb(err)
\n
\nPOST /session/:sessionId/back
\nNavigate backwards in the browser history, if possible.\n		\nback(cb) -> cb(err)
\n
\nPOST /session/:sessionId/refresh
\nRefresh the current page.\n		\nrefresh(cb) -> cb(err)
\n
\nPOST /session/:sessionId/execute
\nInject a snippet of JavaScript into the page for execution in the context of the currently selected frame.\n		\n

\nexecute(code, args, cb) -> cb(err, result)
\nexecute(code, cb) -> cb(err, result)
\nargs: script argument array (optional)
\n

\n

\nExecute script using eval(code):
\nsafeExecute(code, args, cb) -> cb(err, result)
\nsafeExecute(code, cb) -> cb(err, result)
\nargs: script argument array (optional)
\n

\n

\nEvaluate expression (using execute):
\neval(code, cb) -> cb(err, value)
\n

\n

\nEvaluate expression (using safeExecute):
\nsafeEval(code, cb) -> cb(err, value)
\n

\n
\nPOST /session/:sessionId/execute_async
\nInject a snippet of JavaScript into the page for execution in the context of the currently selected frame.\n		\n

\nexecuteAsync(code, args, cb) -> cb(err, result)
\nexecuteAsync(code, cb) -> cb(err, result)
\nargs: script argument array (optional)
\n

\n

\nExecute async script using eval(code):
\nsafeExecuteAsync(code, args, cb) -> cb(err, result)
\nsafeExecuteAsync(code, cb) -> cb(err, result)
\nargs: script argument array (optional)
\n

\n
\nGET /session/:sessionId/screenshot
\nTake a screenshot of the current page.\n		\ntakeScreenshot(cb) -> cb(err, screenshot)
\n
\nPOST /session/:sessionId/frame
\nChange focus to another frame on the page.\n		\nframe(frameRef, cb) -> cb(err)
\n
\nPOST /session/:sessionId/window
\nChange focus to another window.\n		\nwindow(name, cb) -> cb(err)
\n
\nDELETE /session/:sessionId/window
\nClose the current window.\n		\nclose(cb) -> cb(err)
\n
\nPOST /session/:sessionId/window/:windowHandle/size
\nChange the size of the specified window.\n		\n

\nwindowSize(handle, width, height, cb) -> cb(err)
\n

\n

\nsetWindowSize(width, height, handle, cb) -> cb(err)
\nsetWindowSize(width, height, cb) -> cb(err)
\nwidth: width in pixels to set size to
\nheight: height in pixels to set size to
\nhandle: window handle to set size for (optional, default: 'current')
\n

\n
\nGET /session/:sessionId/window/:windowHandle/size
\nGet the size of the specified window.\n		\ngetWindowSize(handle, cb) -> cb(err, size)
\ngetWindowSize(cb) -> cb(err, size)
\nhandle: window handle to get size (optional, default: 'current')
\n
\nPOST /session/:sessionId/window/:windowHandle/position
\nChange the position of the specified window.\n		\nsetWindowPosition(x, y, handle, cb) -> cb(err)
\nsetWindowPosition(x, y, cb) -> cb(err)
\nx: the x-coordinate in pixels to set the window position
\ny: the y-coordinate in pixels to set the window position
\nhandle: window handle to set position for (optional, default: 'current')
\n
\nGET /session/:sessionId/window/:windowHandle/position
\nGet the position of the specified window.\n		\ngetWindowPosition(handle, cb) -> cb(err, position)
\ngetWindowPosition(cb) -> cb(err, position)
\nhandle: window handle to get position (optional, default: 'current')
\n
\nPOST /session/:sessionId/window/:windowHandle/maximize
\nMaximize the specified window if not already maximized.\n		\nmaximize(handle, cb) -> cb(err)
\n
\nGET /session/:sessionId/cookie
\nRetrieve all cookies visible to the current page.\n		\nallCookies() -> cb(err, cookies)
\n
\nPOST /session/:sessionId/cookie
\nSet a cookie.\n		\nsetCookie(cookie, cb) -> cb(err)
\ncookie example:
\n{name:'fruit', value:'apple'}
\n## Optional cookie fields
\npath, domain, secure, expiry
\n
\nDELETE /session/:sessionId/cookie
\nDelete all cookies visible to the current page.\n		\ndeleteAllCookies(cb) -> cb(err)
\n
\nDELETE /session/:sessionId/cookie/:name
\nDelete the cookie with the given name.\n		\ndeleteCookie(name, cb) -> cb(err)
\n
\nGET /session/:sessionId/source
\nGet the current page source.\n		\nsource(cb) -> cb(err, source)
\n
\nGET /session/:sessionId/title
\nGet the current page title.\n		\ntitle(cb) -> cb(err, title)
\n
\nPOST /session/:sessionId/element
\nSearch for an element on the page, starting from the document root.\n		\n

\nelement(using, value, cb) -> cb(err, element)
\n

\n

\nelementByClassName(value, cb) -> cb(err, element)
\nelementByCssSelector(value, cb) -> cb(err, element)
\nelementById(value, cb) -> cb(err, element)
\nelementByName(value, cb) -> cb(err, element)
\nelementByLinkText(value, cb) -> cb(err, element)
\nelementByPartialLinkText(value, cb) -> cb(err, element)
\nelementByTagName(value, cb) -> cb(err, element)
\nelementByXPath(value, cb) -> cb(err, element)
\nelementByCss(value, cb) -> cb(err, element)
\n

\n
\nPOST /session/:sessionId/elements
\nSearch for multiple elements on the page, starting from the document root.\n		\n

\nelements(using, value, cb) -> cb(err, elements)
\n

\n

\nelementsByClassName(value, cb) -> cb(err, elements)
\nelementsByCssSelector(value, cb) -> cb(err, elements)
\nelementsById(value, cb) -> cb(err, elements)
\nelementsByName(value, cb) -> cb(err, elements)
\nelementsByLinkText(value, cb) -> cb(err, elements)
\nelementsByPartialLinkText(value, cb) -> cb(err, elements)
\nelementsByTagName(value, cb) -> cb(err, elements)
\nelementsByXPath(value, cb) -> cb(err, elements)
\nelementsByCss(value, cb) -> cb(err, elements)
\n

\n

\n## Retrieve an element avoiding not found exception and returning null instead
\nelementOrNull(using, value, cb) -> cb(err, element)
\n

\n

\nelementByClassNameOrNull(value, cb) -> cb(err, element)
\nelementByCssSelectorOrNull(value, cb) -> cb(err, element)
\nelementByIdOrNull(value, cb) -> cb(err, element)
\nelementByNameOrNull(value, cb) -> cb(err, element)
\nelementByLinkTextOrNull(value, cb) -> cb(err, element)
\nelementByPartialLinkTextOrNull(value, cb) -> cb(err, element)
\nelementByTagNameOrNull(value, cb) -> cb(err, element)
\nelementByXPathOrNull(value, cb) -> cb(err, element)
\nelementByCssOrNull(value, cb) -> cb(err, element)
\n

\n

\n## Retrieve an element avoiding not found exception and returning undefined instead
\nelementIfExists(using, value, cb) -> cb(err, element)
\n

\n

\nelementByClassNameIfExists(value, cb) -> cb(err, element)
\nelementByCssSelectorIfExists(value, cb) -> cb(err, element)
\nelementByIdIfExists(value, cb) -> cb(err, element)
\nelementByNameIfExists(value, cb) -> cb(err, element)
\nelementByLinkTextIfExists(value, cb) -> cb(err, element)
\nelementByPartialLinkTextIfExists(value, cb) -> cb(err, element)
\nelementByTagNameIfExists(value, cb) -> cb(err, element)
\nelementByXPathIfExists(value, cb) -> cb(err, element)
\nelementByCssIfExists(value, cb) -> cb(err, element)
\n

\n

\n## Check if element exists
\nhasElement(using, value, cb) -> cb(err, boolean)
\n

\n

\nhasElementByClassName(value, cb) -> cb(err, boolean)
\nhasElementByCssSelector(value, cb) -> cb(err, boolean)
\nhasElementById(value, cb) -> cb(err, boolean)
\nhasElementByName(value, cb) -> cb(err, boolean)
\nhasElementByLinkText(value, cb) -> cb(err, boolean)
\nhasElementByPartialLinkText(value, cb) -> cb(err, boolean)
\nhasElementByTagName(value, cb) -> cb(err, boolean)
\nhasElementByXPath(value, cb) -> cb(err, boolean)
\nhasElementByCss(value, cb) -> cb(err, boolean)
\n

\n
\nPOST /session/:sessionId/element/active
\nGet the element on the page that currently has focus.\n		\nactive(cb) -> cb(err, element)
\n
\nPOST /session/:sessionId/element/:id/element
\nSearch for an element on the page, starting from the identified element.\n		\n

\nelement.element(using, value, cb) -> cb(err, element)
\n

\n

\nelement.elementByClassName(value, cb) -> cb(err, element)
\nelement.elementByCssSelector(value, cb) -> cb(err, element)
\nelement.elementById(value, cb) -> cb(err, element)
\nelement.elementByName(value, cb) -> cb(err, element)
\nelement.elementByLinkText(value, cb) -> cb(err, element)
\nelement.elementByPartialLinkText(value, cb) -> cb(err, element)
\nelement.elementByTagName(value, cb) -> cb(err, element)
\nelement.elementByXPath(value, cb) -> cb(err, element)
\nelement.elementByCss(value, cb) -> cb(err, element)
\n

\n
\nPOST /session/:sessionId/element/:id/elements
\nSearch for multiple elements on the page, starting from the identified element.\n		\n

\nelement.elements(using, value, cb) -> cb(err, elements)
\n

\n

\nelement.elementsByClassName(value, cb) -> cb(err, elements)
\nelement.elementsByCssSelector(value, cb) -> cb(err, elements)
\nelement.elementsById(value, cb) -> cb(err, elements)
\nelement.elementsByName(value, cb) -> cb(err, elements)
\nelement.elementsByLinkText(value, cb) -> cb(err, elements)
\nelement.elementsByPartialLinkText(value, cb) -> cb(err, elements)
\nelement.elementsByTagName(value, cb) -> cb(err, elements)
\nelement.elementsByXPath(value, cb) -> cb(err, elements)
\nelement.elementsByCss(value, cb) -> cb(err, elements)
\n

\n
\nPOST /session/:sessionId/element/:id/click
\nClick on an element.\n		\n

\nclickElement(element, cb) -> cb(err)
\n

\n

\nelement.click(cb) -> cb(err)
\n

\n
\nPOST /session/:sessionId/element/:id/submit
\nSubmit a FORM element.\n		\nsubmit(element, cb) -> cb(err)
\nSubmit a `FORM` element.
\n
\nGET /session/:sessionId/element/:id/text
\nReturns the visible text for the element.\n		\n

\ntext(element, cb) -> cb(err, text)
\nelement: specific element, 'body', or undefined
\n

\n

\nelement.text(cb) -> cb(err, text)
\n

\n

\n## Check if text is present
\ntextPresent(searchText, element, cb) -> cb(err, boolean)
\nelement: specific element, 'body', or undefined
\n

\n

\nelement.textPresent(searchText, cb) -> cb(err, boolean)
\n

\n
\nPOST /session/:sessionId/element/:id/value
\nSend a sequence of key strokes to an element.\n		\n

\ntype(element, keys, cb) -> cb(err)
\nType keys (all keys are up at the end of command).
\nspecial key map: wd.SPECIAL_KEYS (see lib/special-keys.js)
\n

\n

\nelement.type(keys, cb) -> cb(err)
\n

\n
\nPOST /session/:sessionId/keys
\nSend a sequence of key strokes to the active element.\n		\nkeys(keys, cb) -> cb(err)
\nPress keys (keys may still be down at the end of command).
\nspecial key map: wd.SPECIAL_KEYS (see lib/special-keys.js)
\n
\nGET /session/:sessionId/element/:id/name
\nQuery for an element's tag name.\n		\n

\ngetTagName(element, cb) -> cb(err, name)
\n

\n

\nelement.getTagName(cb) -> cb(err, name)
\n

\n
\nPOST /session/:sessionId/element/:id/clear
\nClear a TEXTAREA or text INPUT element's value.\n		\n

\nclear(element, cb) -> cb(err)
\n

\n

\nelement.clear(cb) -> cb(err)
\n

\n
\nGET /session/:sessionId/element/:id/selected
\nDetermine if an OPTION element, or an INPUT element of type checkbox or radiobutton is currently selected.\n		\n

\nisSelected(element, cb) -> cb(err, selected)
\n

\n

\nelement.isSelected(cb) -> cb(err, selected)
\n

\n
\nGET /session/:sessionId/element/:id/enabled
\nDetermine if an element is currently enabled.\n		\n

\nisEnabled(element, cb) -> cb(err, enabled)
\n

\n

\nelement.isEnabled(cb) -> cb(err, enabled)
\n

\n
\nGET /session/:sessionId/element/:id/attribute/:name
\nGet the value of an element's attribute.\n		\n

\ngetAttribute(element, attrName, cb) -> cb(err, value)
\n

\n

\nelement.getAttribute(attrName, cb) -> cb(err, value)
\n

\n

\nGet element value (in value attribute):
\ngetValue(element, cb) -> cb(err, value)
\n

\n

\nelement.getValue(cb) -> cb(err, value)
\n

\n
\nGET /session/:sessionId/element/:id/equals/:other
\nTest if two element IDs refer to the same DOM element.\n		\n

\nelement.equals(other, cb) -> cb(err, value)
\n

\n

\nequalsElement(element, other , cb) -> cb(err, value)
\n

\n
\nGET /session/:sessionId/element/:id/displayed
\nDetermine if an element is currently displayed.\n		\n

\nisDisplayed(element, cb) -> cb(err, displayed)
\n

\n

\nelement.isDisplayed(cb) -> cb(err, displayed)
\n

\n
\nGET /session/:sessionId/element/:id/location
\nDetermine an element's location on the page.\n		\n

\ngetLocation(element, cb) -> cb(err, location)
\n

\n

\nelement.getLocation(cb) -> cb(err, location)
\n

\n
\nGET /session/:sessionId/element/:id/size
\nDetermine an element's size in pixels.\n		\n

\ngetSize(element, cb) -> cb(err, size)
\n

\n

\nelement.getSize(cb) -> cb(err, size)
\n

\n
\nGET /session/:sessionId/element/:id/css/:propertyName
\nQuery the value of an element's computed CSS property.\n		\n

\ngetComputedCss(element, cssProperty , cb) -> cb(err, value)
\n

\n

\nelement.getComputedCss(cssProperty , cb) -> cb(err, value)
\n

\n

\nelement.getComputedCss(cssProperty , cb) -> cb(err, value)
\n

\n
\nGET /session/:sessionId/orientation
\nGet the current browser orientation.\n		\ngetOrientation(cb) -> cb(err, orientation)
\n
\nPOST /session/:sessionId/orientation
\nSet the browser orientation.\n		\nsetOrientation(cb) -> cb(err, orientation)
\n
\nGET /session/:sessionId/alert_text
\nGets the text of the currently displayed JavaScript alert(), confirm(), or prompt() dialog.\n		\nalertText(cb) -> cb(err, text)
\n
\nPOST /session/:sessionId/alert_text
\nSends keystrokes to a JavaScript prompt() dialog.\n		\nalertKeys(keys, cb) -> cb(err)
\n
\nPOST /session/:sessionId/accept_alert
\nAccepts the currently displayed alert dialog.\n		\nacceptAlert(cb) -> cb(err)
\n
\nPOST /session/:sessionId/dismiss_alert
\nDismisses the currently displayed alert dialog.\n		\ndismissAlert(cb) -> cb(err)
\n
\nPOST /session/:sessionId/moveto
\nMove the mouse by an offset of the specificed element.\n		\nmoveTo(element, xoffset, yoffset, cb) -> cb(err)
\nMove to element, xoffset and y offset are optional.
\n
\nPOST /session/:sessionId/click
\nClick any mouse button (at the coordinates set by the last moveto command).\n		\nclick(button, cb) -> cb(err)
\nClick on current element.
\nButtons: {left: 0, middle: 1 , right: 2}
\n
\nPOST /session/:sessionId/buttondown
\nClick and hold the left mouse button (at the coordinates set by the last moveto command).\n		\nbuttonDown(cb) -> cb(err)
\n
\nPOST /session/:sessionId/buttonup
\nReleases the mouse button previously held (where the mouse is currently at).\n		\nbuttonUp(cb) -> cb(err)
\n
\nPOST /session/:sessionId/doubleclick
\nDouble-clicks at the current mouse coordinates (set by moveto).\n		\ndoubleclick(cb) -> cb(err)
\n
\nPOST /session/:sessionId/touch/flick
\nFlick on the touch screen using finger motion events.\n		\n

\nflick(xSpeed, ySpeed, swipe, cb) -> cb(err)
\nFlicks, starting anywhere on the screen.
\nflick(element, xoffset, yoffset, speed, cb) -> cb(err)
\nFlicks, starting at element center.
\n

\n

\nelement.flick(xoffset, yoffset, speed, cb) -> cb(err)
\n

\n
\nPOST /session/:sessionId/local_storage
\nSet the storage item for the given key.\n		\nsetLocalStorageKey(key, value, cb) -> cb(err)
\n# uses safeExecute() due to localStorage bug in Selenium
\n
\nDELETE /session/:sessionId/local_storage
\nClear the storage.\n		\nclearLocalStorage(cb) -> cb(err)
\n# uses safeExecute() due to localStorage bug in Selenium
\n
\nGET /session/:sessionId/local_storage/key/:key
\nGet the storage item for the given key.\n		\ngetLocalStorageKey(key, cb) -> cb(err)
\n# uses safeEval() due to localStorage bug in Selenium
\n
\nDELETE /session/:sessionId/local_storage/key/:key
\nRemove the storage item for the given key.\n		\nremoveLocalStorageKey(key, cb) -> cb(err)
\n# uses safeExecute() due to localStorage bug in Selenium
\n
\nEXTRA\n\nOpens a new window (using Javascript window.open):
\nnewWindow(url, name, cb) -> cb(err)
\nnewWindow(url, cb) -> cb(err)
\nname: optional window name
\nWindow can later be accessed by name with the window method,
\nor by getting the last handle returned by the windowHandles method.
\n
\nEXTRA\n\nwindowName(cb) -> cb(err, name)
\n
\nEXTRA\n\nwaitForElement(using, value, timeout, cb) -> cb(err)
\n
\nEXTRA\n\nwaitForVisible(using, value, timeout, cb) -> cb(err)
\n
\nEXTRA\n\nwaitForElementByClassName(value, timeout, cb) -> cb(err)
\nwaitForElementByCssSelector(value, timeout, cb) -> cb(err)
\nwaitForElementById(value, timeout, cb) -> cb(err)
\nwaitForElementByName(value, timeout, cb) -> cb(err)
\nwaitForElementByLinkText(value, timeout, cb) -> cb(err)
\nwaitForElementByPartialLinkText(value, timeout, cb) -> cb(err)
\nwaitForElementByTagName(value, timeout, cb) -> cb(err)
\nwaitForElementByXPath(value, timeout, cb) -> cb(err)
\nwaitForElementByCss(value, timeout, cb) -> cb(err)
\n
\nEXTRA\n\nwaitForVisibleByClassName(value, timeout, cb) -> cb(err)
\nwaitForVisibleByCssSelector(value, timeout, cb) -> cb(err)
\nwaitForVisibleById(value, timeout, cb) -> cb(err)
\nwaitForVisibleByName(value, timeout, cb) -> cb(err)
\nwaitForVisibleByLinkText(value, timeout, cb) -> cb(err)
\nwaitForVisibleByPartialLinkText(value, timeout, cb) -> cb(err)
\nwaitForVisibleByTagName(value, timeout, cb) -> cb(err)
\nwaitForVisibleByXPath(value, timeout, cb) -> cb(err)
\nwaitForVisibleByCss(value, timeout, cb) -> cb(err)
\n
\nEXTRA\n\nisVisible(element , cb) -> cb(err, boolean)
\nisVisible(queryType, querySelector, cb) -> cb(err, boolean)
\n
\nEXTRA\n\nRetrieves the pageIndex element (added for Appium):
\ngetPageIndex(element, cb) -> cb(err, pageIndex)
\n
\nEXTRA\n\nWaits for JavaScript condition to be true (polling within wd client):
\nwaitForCondition(conditionExpr, timeout, pollFreq, cb) -> cb(err, boolean)
\nwaitForCondition(conditionExpr, timeout, cb) -> cb(err, boolean)
\nwaitForCondition(conditionExpr, cb) -> cb(err, boolean)
\nconditionExpr: condition expression, should return a boolean
\ntimeout: timeout (optional, default: 1000)
\npollFreq: pooling frequency (optional, default: 100)
\nreturn true if condition satisfied, error otherwise.
\n
\nEXTRA\n\nWaits for JavaScript condition to be true (async script polling within browser):
\nwaitForConditionInBrowser(conditionExpr, timeout, pollFreq, cb) -> cb(err, boolean)
\nwaitForConditionInBrowser(conditionExpr, timeout, cb) -> cb(err, boolean)
\nwaitForConditionInBrowser(conditionExpr, cb) -> cb(err, boolean)
\nconditionExpr: condition expression, should return a boolean
\ntimeout: timeout (optional, default: 1000)
\npollFreq: pooling frequency (optional, default: 100)
\nreturn true if condition satisfied, error otherwise.
\n
\nEXTRA\n\nisVisible(cb) -> cb(err, boolean)
\n
\n\n## JsonWireProtocol mapping\n\n[supported mapping](https://github.com/admc/wd/blob/master/doc/jsonwire-mapping.md)\n\n[full mapping](https://github.com/admc/wd/blob/master/doc/jsonwire-full-mapping.md)\n\n## More docs!\n
\nWD is simply implementing the Selenium JsonWireProtocol, for more details see the official docs:\n - http://code.google.com/p/selenium/wiki/JsonWireProtocol\n
\n\n## Run the tests!\n
\n  - Install the Selenium server and Chromedriver\n      node_modules/.bin/install_selenium\n      node_modules/.bin/install_chromedriver\n  - Run the selenium server with chromedriver:\n      node_modules/.bin/start_selenium_with_chromedriver\n  - cd wd\n  - npm install .\n  - make test\n  - look at the results!\n
\n\n## Run the tests on Sauce Labs cloud!\n
\n  - cd wd\n  - npm install .\n  - make test_saucelabs\n
\n\n## Adding new method / Contributing\n\nIf the method you want to use is not yet implemented, that should be\neasy to add it to `lib/webdriver.js`. You can use the `doubleclick`\nmethod as a template for methods not returning data, and `getOrientation`\nfor methods which returns data. No need to modify README as the doc\ngeneration is automated. Other contributions are welcomed.\n\n## Doc\n\nThe JsonWire mappings in the README and mapping files are generated from code\ncomments using [dox](https://github.com/visionmedia/dox).\n\nTo update the mappings run the following commands:\n\n
\n  - make mapping > doc/jsonwire-mapping.md\n  - make full_mapping > doc/jsonwire-full-mapping.md\n
\n\nThe content of doc/jsonwire-mapping.md should then be manually integrated into\nREADME.md.\n\n## Test Coverage\n\n[test coverage](http://admc.io/wd/coverage.html)\n", "readmeFilename": "README.md", "_id": "wd@0.0.32", "_from": "wd@" }