{ "id": 0, "name": "@theintern/leadfoot", "kind": 0, "flags": {}, "originalName": "", "children": [ { "id": 1215, "name": "\"Command\"", "kind": 1, "kindString": "Module", "flags": { "isExported": true, "isExternal": true }, "originalName": "src/Command.ts", "children": [ { "id": 1216, "name": "Command", "kind": 128, "kindString": "Class", "flags": { "isExported": true, "isExternal": true }, "comment": { "shortText": "The Command class is a chainable, subclassable object type that can be used\nto execute commands serially against a remote WebDriver environment. The\nstandard Command class includes methods from the [[Session]] and [[Element]]\nclasses, so you can perform all standard session and element operations that\ncome with Leadfoot without being forced to author long promise chains.", "text": "In order to use the Command class, you first need to pass it a [[Session]]\ninstance for it to use:\n\n```js\nconst command = new Command(session);\n```\n\nOnce you have created the Command, you can then start chaining methods, and\nthey will execute in order one after another:\n\n```js\ncommand.get('http://example.com')\n .findByTagName('h1')\n .getVisibleText()\n .then(function (text) {\n assert.strictEqual(text, 'Example Domain');\n });\n```\n\nBecause these operations are asynchronous, you need to use a `then` callback\nin order to retrieve the value from the last method. Command objects are\nPromiseLikes, which means that they can be used with any Promises/A+ or\nES6-conformant Promises implementation, though there are some specific\ndifferences in the arguments and context that are provided to callbacks; see\n[[Command.Command.then]] for more details.\n\nBecause Commands are promise-like, they may also be used with `async/await`:\n\n```js\nconst page = await command.get('http://example.com');\nconst h1 = await page.findByTagName('h1');\nconst text = await h1.getVisibleText();\nassert.strictEqual(text, 'Example Domain');\n```\n\n---\n\nEach call on a Command generates a new Command object, which means that\ncertain operations can be parallelised:\n\n```js\ncommand = command.get('http://example.com');\nPromise.all([\n command.getPageTitle(),\n command.findByTagName('h1').getVisibleText()\n]).then(results => {\n assert.strictEqual(results[0], results[1]);\n});\n```\n\nIn this example, the commands on line 3 and 4 both depend upon the `get`\ncall completing successfully but are otherwise independent of each other and\nso execute here in parallel. This is different from commands in Intern 1\nwhich were always chained onto the last called method within a given test.\n\n---\n\nCommand objects actually encapsulate two different types of interaction:\n*session* interactions, which operate against the entire browser session,\nand *element* interactions, which operate against specific elements taken\nfrom the currently loaded page. Things like navigating the browser, moving\nthe mouse cursor, and executing scripts are session interactions; things\nlike getting text displayed on the page, typing into form fields, and\ngetting element attributes are element interactions.\n\nSession interactions can be performed at any time, from any Command. On the\nother hand, to perform element interactions, you first need to retrieve one\nor more elements to interact with. This can be done using any of the `find`\nor `findAll` methods, by the `getActiveElement` method, or by returning\nelements from `execute` or `executeAsync` calls. The retrieved elements are\nstored internally as the *element context* of all chained Commands. When an\nelement method is called on a chained Command with a single element context,\nthe result will be returned as-is:\n\n```js\ncommand = command.get('http://example.com')\n // finds one element -> single element context\n .findByTagName('h1')\n .getVisibleText()\n .then(text => {\n // `text` is the text from the element context\n assert.strictEqual(text, 'Example Domain');\n });\n```\n\nWhen an element method is called on a chained Command with a multiple\nelement context, the result will be returned as an array:\n\n```js\ncommand = command.get('http://example.com')\n // finds multiple elements -> multiple element context\n .findAllByTagName('p')\n .getVisibleText()\n .then(texts => {\n // `texts` is an array of text from each of the `p` elements\n assert.deepEqual(texts, [\n 'This domain is established to be used for […]',\n 'More information...'\n ]);\n });\n```\n\nThe `find` and `findAll` methods are special and change their behaviour\nbased on the current element filtering state of a given command. If a\ncommand has been filtered by element, the `find` and `findAll` commands will\nonly find elements *within* the currently filtered set of elements.\nOtherwise, they will find elements throughout the page.\n\nSome method names, like `click`, are identical for both Session and Element\nAPIs; in this case, the element APIs are suffixed with the word `Element` in\norder to identify them uniquely.\n\n---\n\nCommands can be subclassed in order to add additional functionality without\nmaking direct modifications to the default Command prototype that might\nbreak other parts of the system:\n\n```ts\nclass CustomCommand extends Command {\n login(username: string, password: string) {\n return new this.constructor(this, function () {\n return this.parent\n .findById('username')\n .click()\n .type(username)\n .end()\n\n .findById('password')\n .click()\n .type(password)\n .end()\n\n .findById('login')\n .click()\n .end();\n });\n }\n}\n```\n\n> ⚠️Note that returning `this`, or a command chain starting from `this`,\nfrom a callback or command initialiser will deadlock the Command, as it\nwaits for itself to settle before settling.\n" }, "typeParameter": [ { "id": 1217, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": { "isExported": true } }, { "id": 1218, "name": "P", "kind": 131072, "kindString": "Type parameter", "flags": { "isExported": true } }, { "id": 1219, "name": "StringResult", "kind": 131072, "kindString": "Type parameter", "flags": { "isExported": true }, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } } ] } } ], "children": [ { "id": 1239, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": { "isExported": true, "isExternal": true }, "comment": {}, "signatures": [ { "id": 1240, "name": "new Command", "kind": 16384, "kindString": "Constructor signature", "flags": { "isExported": true }, "comment": {}, "parameters": [ { "id": 1241, "name": "parentOrSession", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "union", "types": [ { "type": "reference", "id": 650, "name": "Session" }, { "type": "reference", "id": 1216, "typeArguments": [ { "type": "typeParameter", "name": "P", "default": { "type": "intrinsic", "name": "any" } }, { "type": "intrinsic", "name": "any" }, { "type": "typeParameter", "name": "StringResult", "constraint": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } } ] }, "default": { "type": "intrinsic", "name": "string" } } ], "name": "Command" }, { "type": "intrinsic", "name": "null" } ] } }, { "id": 1242, "name": "initialiser", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true, "isOptional": true }, "comment": { "shortText": "A function that will be executed when all parent\ncommands have completed execution. This function can create a new\ncontext for this command by calling the passed `setContext` function any\ntime prior to resolving the Promise that it returns. If no context is\nexplicitly provided, the context from the parent command will be used.\n" }, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "reflection", "declaration": { "id": 1243, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "signatures": [ { "id": 1244, "name": "__call", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 1245, "name": "this", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reference", "id": 1216, "typeArguments": [ { "type": "typeParameter", "name": "T" }, { "type": "typeParameter", "name": "P", "default": { "type": "intrinsic", "name": "any" } }, { "type": "typeParameter", "name": "StringResult", "constraint": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } } ] }, "default": { "type": "intrinsic", "name": "string" } } ], "name": "Command" } }, { "id": 1246, "name": "setContext", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reference", "id": 1678, "name": "SetContextMethod" } }, { "id": 1247, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "typeParameter", "name": "T" } } ], "type": { "type": "union", "types": [ { "type": "typeParameter", "name": "T" }, { "type": "reference", "typeArguments": [ { "type": "typeParameter", "name": "T" } ], "name": "PromiseLike" } ] } } ] } } ] } }, { "id": 1248, "name": "errback", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true, "isOptional": true }, "comment": { "shortText": "A function that will be executed if any parent commands\nfailed to complete successfully. This function can create a new context\nfor the current command by calling the passed `setContext` function any\ntime prior to resolving the Promise that it returns. If no context is\nexplicitly provided, the context from the parent command will be used.\n" }, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "reflection", "declaration": { "id": 1249, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "signatures": [ { "id": 1250, "name": "__call", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 1251, "name": "this", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reference", "id": 1216, "typeArguments": [ { "type": "typeParameter", "name": "T" }, { "type": "typeParameter", "name": "P", "default": { "type": "intrinsic", "name": "any" } }, { "type": "typeParameter", "name": "StringResult", "constraint": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } } ] }, "default": { "type": "intrinsic", "name": "string" } } ], "name": "Command" } }, { "id": 1252, "name": "setContext", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reference", "id": 1678, "name": "SetContextMethod" } }, { "id": 1253, "name": "error", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "any" } } ], "type": { "type": "union", "types": [ { "type": "typeParameter", "name": "T" }, { "type": "reference", "typeArguments": [ { "type": "typeParameter", "name": "T" } ], "name": "PromiseLike" } ] } } ] } } ] } } ], "type": { "type": "reference", "id": 1216, "name": "Command" } } ], "sources": [ { "fileName": "src/Command.ts", "line": 333, "character": 41 } ] }, { "id": 1258, "name": "context", "kind": 262144, "kindString": "Accessor", "flags": { "isExported": true, "isExternal": true }, "comment": { "shortText": "The filtered elements that will be used if an element-specific method is\ninvoked. Note that this property is not valid until the parent Command\nhas been settled. The context array also has two additional properties:", "text": "* `isSingle` (boolean): If true, the context will always contain a\n single element. This is used to differentiate between methods that\n should still return scalar values (`find`) and methods that should\n return arrays of values even if there is only one element in the\n context (`findAll`).\n* `depth` (number): The depth of the context within the command chain.\n This is used to prevent traversal into higher filtering levels by\n [[Command.Command.end]].\n" }, "getSignature": [ { "id": 1259, "name": "__get", "kind": 524288, "kindString": "Get signature", "flags": { "isExported": true }, "comment": { "shortText": "The filtered elements that will be used if an element-specific method is\ninvoked. Note that this property is not valid until the parent Command\nhas been settled. The context array also has two additional properties:", "text": "* `isSingle` (boolean): If true, the context will always contain a\n single element. This is used to differentiate between methods that\n should still return scalar values (`find`) and methods that should\n return arrays of values even if there is only one element in the\n context (`findAll`).\n* `depth` (number): The depth of the context within the command chain.\n This is used to prevent traversal into higher filtering levels by\n [[Command.Command.end]].\n" }, "type": { "type": "reference", "id": 1681, "name": "Context" } } ], "sources": [ { "fileName": "src/Command.ts", "line": 483, "character": 13 } ] }, { "id": 1254, "name": "parent", "kind": 262144, "kindString": "Accessor", "flags": { "isExported": true, "isExternal": true }, "comment": { "shortText": "The parent Command of the Command, if one exists. This will be defined\nfor all commands but the top-level Session command (i.e., in most\ncontexts user code will call it)." }, "getSignature": [ { "id": 1255, "name": "__get", "kind": 524288, "kindString": "Get signature", "flags": { "isExported": true }, "comment": { "shortText": "The parent Command of the Command, if one exists. This will be defined\nfor all commands but the top-level Session command (i.e., in most\ncontexts user code will call it)." }, "type": { "type": "reference", "id": 1216, "typeArguments": [ { "type": "unknown", "name": "P" }, { "type": "intrinsic", "name": "any" }, { "type": "unknown", "name": "StringResult" } ], "name": "Command" } } ], "sources": [ { "fileName": "src/Command.ts", "line": 458, "character": 12 } ] }, { "id": 1260, "name": "promise", "kind": 262144, "kindString": "Accessor", "flags": { "isExported": true, "isExternal": true }, "comment": { "shortText": "The underlying Promise for the Command.", "tags": [ { "tag": "readonly", "text": "\n" } ] }, "getSignature": [ { "id": 1261, "name": "__get", "kind": 524288, "kindString": "Get signature", "flags": { "isExported": true }, "comment": { "shortText": "The underlying Promise for the Command.", "tags": [ { "tag": "readonly", "text": "\n" } ] }, "type": { "type": "reference", "typeArguments": [ { "type": "intrinsic", "name": "any" } ], "name": "CancellablePromise" } } ], "sources": [ { "fileName": "src/Command.ts", "line": 492, "character": 13 } ] }, { "id": 1256, "name": "session", "kind": 262144, "kindString": "Accessor", "flags": { "isExported": true, "isExternal": true }, "comment": { "shortText": "The parent Session of the Command." }, "getSignature": [ { "id": 1257, "name": "__get", "kind": 524288, "kindString": "Get signature", "flags": { "isExported": true }, "comment": { "shortText": "The parent Session of the Command." }, "type": { "type": "reference", "id": 650, "name": "Session" } } ], "sources": [ { "fileName": "src/Command.ts", "line": 465, "character": 13 } ] }, { "id": 1444, "name": "acceptAlert", "kind": 2048, "kindString": "Method", "flags": { "isExported": true, "isExternal": true }, "signatures": [ { "id": 1445, "name": "acceptAlert", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Accepts an alert, prompt, or confirmation pop-up. Equivalent to clicking\nthe 'OK' button." }, "type": { "type": "reference", "id": 1216, "typeArguments": [ { "type": "intrinsic", "name": "void" }, { "type": "unknown", "name": "P" }, { "type": "unknown", "name": "StringResult" } ], "name": "Command" } } ], "sources": [ { "fileName": "src/Command.ts", "line": 1294, "character": 13 } ] }, { "id": 1371, "name": "activateIme", "kind": 2048, "kindString": "Method", "flags": { "isExported": true, "isExternal": true }, "signatures": [ { "id": 1372, "name": "activateIme", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Activates an input method editor in the remote environment.\nAs of April 2014, no known remote environments support IME functions." }, "parameters": [ { "id": 1373, "name": "engine", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The type of IME to activate.\n" }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "id": 1216, "typeArguments": [ { "type": "intrinsic", "name": "void" }, { "type": "unknown", "name": "P" }, { "type": "unknown", "name": "StringResult" } ], "name": "Command" } } ], "sources": [ { "fileName": "src/Command.ts", "line": 1044, "character": 13 } ] }, { "id": 1296, "name": "cancel", "kind": 2048, "kindString": "Method", "flags": { "isExported": true, "isExternal": true }, "signatures": [ { "id": 1297, "name": "cancel", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Cancels all outstanding chained operations of the Command. Calling this\nmethod will cause this command and all subsequent chained commands to\nfail with a CancelError." }, "type": { "type": "unknown", "name": "this" } } ], "sources": [ { "fileName": "src/Command.ts", "line": 707, "character": 8 } ] }, { "id": 1283, "name": "catch", "kind": 2048, "kindString": "Method", "flags": { "isExported": true, "isExternal": true }, "signatures": [ { "id": 1284, "name": "catch", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Adds a callback to be invoked when any of the previously chained\noperations have failed." }, "typeParameter": [ { "id": 1285, "name": "R", "kind": 131072, "kindString": "Type parameter", "flags": { "isExported": true } } ], "parameters": [ { "id": 1286, "name": "errback", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reflection", "declaration": { "id": 1287, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "signatures": [ { "id": 1288, "name": "__call", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 1289, "name": "this", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reference", "id": 1216, "typeArguments": [ { "type": "typeParameter", "name": "T" }, { "type": "typeParameter", "name": "P", "default": { "type": "intrinsic", "name": "any" } }, { "type": "typeParameter", "name": "StringResult", "constraint": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } } ] }, "default": { "type": "intrinsic", "name": "string" } } ], "name": "Command" } }, { "id": 1290, "name": "reason", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "any" } } ], "type": { "type": "union", "types": [ { "type": "typeParameter", "name": "R", "default": { "type": "intrinsic", "name": "never" } }, { "type": "reference", "typeArguments": [ { "type": "typeParameter", "name": "R", "default": { "type": "intrinsic", "name": "never" } } ], "name": "PromiseLike" } ] } } ], "sources": [ { "fileName": "src/Command.ts", "line": 685, "character": 12 } ] } } } ], "type": { "type": "intrinsic", "name": "any" } } ], "sources": [ { "fileName": "src/Command.ts", "line": 684, "character": 7 } ] }, { "id": 1420, "name": "clearCookies", "kind": 2048, "kindString": "Method", "flags": { "isExported": true, "isExternal": true }, "signatures": [ { "id": 1421, "name": "clearCookies", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Clears all cookies for the current page." }, "type": { "type": "reference", "id": 1216, "typeArguments": [ { "type": "intrinsic", "name": "void" }, { "type": "unknown", "name": "P" }, { "type": "unknown", "name": "StringResult" } ], "name": "Command" } } ], "sources": [ { "fileName": "src/Command.ts", "line": 1204, "character": 14 } ] }, { "id": 1550, "name": "clearValue", "kind": 2048, "kindString": "Method", "flags": { "isExported": true, "isExternal": true }, "signatures": [ { "id": 1551, "name": "clearValue", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Clears the value of a form element." }, "type": { "type": "reference", "id": 1216, "typeArguments": [ { "type": "intrinsic", "name": "void" }, { "type": "unknown", "name": "P" }, { "type": "unknown", "name": "StringResult" } ], "name": "Command" } } ], "sources": [ { "fileName": "src/Command.ts", "line": 1683, "character": 12 } ] }, { "id": 1539, "name": "click", "kind": 2048, "kindString": "Method", "flags": { "isExported": true, "isExternal": true }, "signatures": [ { "id": 1540, "name": "click", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Clicks the element. This method works on both mouse and touch platforms." }, "type": { "type": "reference", "id": 1216, "typeArguments": [ { "type": "intrinsic", "name": "void" }, { "type": "unknown", "name": "P" }, { "type": "unknown", "name": "StringResult" } ], "name": "Command" } } ], "sources": [ { "fileName": "src/Command.ts", "line": 1631, "character": 7 } ] }, { "id": 1456, "name": "clickMouseButton", "kind": 2048, "kindString": "Method", "flags": { "isExported": true, "isExternal": true }, "signatures": [ { "id": 1457, "name": "clickMouseButton", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Clicks a mouse button at the point where the mouse cursor is currently\npositioned. This method may fail to execute with an error if the mouse\nhas not been moved anywhere since the page was loaded." }, "parameters": [ { "id": 1458, "name": "button", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true, "isOptional": true }, "comment": { "text": "The button to click. 0 corresponds to the primary mouse\nbutton, 1 to the middle mouse button, 2 to the secondary mouse button.\nNumbers above 2 correspond to any additional buttons a mouse might\nprovide.\n" }, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "number" } ] } } ], "type": { "type": "reference", "id": 1216, "typeArguments": [ { "type": "intrinsic", "name": "void" }, { "type": "unknown", "name": "P" }, { "type": "unknown", "name": "StringResult" } ], "name": "Command" } } ], "sources": [ { "fileName": "src/Command.ts", "line": 1351, "character": 18 } ] }, { "id": 1382, "name": "closeCurrentWindow", "kind": 2048, "kindString": "Method", "flags": { "isExported": true, "isExternal": true }, "signatures": [ { "id": 1383, "name": "closeCurrentWindow", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Closes the currently focused window. In most environments, after the\nwindow has been closed, it is necessary to explicitly switch to whatever\nwindow is now focused." }, "type": { "type": "reference", "id": 1216, "typeArguments": [ { "type": "intrinsic", "name": "void" }, { "type": "unknown", "name": "P" }, { "type": "unknown", "name": "StringResult" } ], "name": "Command" } } ], "sources": [ { "fileName": "src/Command.ts", "line": 1089, "character": 20 } ] }, { "id": 1369, "name": "deactivateIme", "kind": 2048, "kindString": "Method", "flags": { "isExported": true, "isExternal": true }, "signatures": [ { "id": 1370, "name": "deactivateIme", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Deactivates any active input method editor in the remote environment.\nAs of April 2014, no known remote environments support IME functions." }, "type": { "type": "reference", "id": 1216, "typeArguments": [ { "type": "intrinsic", "name": "void" }, { "type": "unknown", "name": "P" }, { "type": "unknown", "name": "StringResult" } ], "name": "Command" } } ], "sources": [ { "fileName": "src/Command.ts", "line": 1034, "character": 15 } ] }, { "id": 1422, "name": "deleteCookie", "kind": 2048, "kindString": "Method", "flags": { "isExported": true, "isExternal": true }, "signatures": [ { "id": 1423, "name": "deleteCookie", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Deletes a cookie on the current page." }, "parameters": [ { "id": 1424, "name": "name", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The name of the cookie to delete.\n" }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "id": 1216, "typeArguments": [ { "type": "intrinsic", "name": "void" }, { "type": "unknown", "name": "P" }, { "type": "unknown", "name": "StringResult" } ], "name": "Command" } } ], "sources": [ { "fileName": "src/Command.ts", "line": 1213, "character": 14 } ] }, { "id": 1446, "name": "dismissAlert", "kind": 2048, "kindString": "Method", "flags": { "isExported": true, "isExternal": true }, "signatures": [ { "id": 1447, "name": "dismissAlert", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Dismisses an alert, prompt, or confirmation pop-up. Equivalent to\nclicking the 'OK' button of an alert pop-up or the 'Cancel' button of a\nprompt or confirmation pop-up." }, "type": { "type": "reference", "id": 1216, "typeArguments": [ { "type": "intrinsic", "name": "void" }, { "type": "unknown", "name": "P" }, { "type": "unknown", "name": "StringResult" } ], "name": "Command" } } ], "sources": [ { "fileName": "src/Command.ts", "line": 1303, "character": 14 } ] }, { "id": 1465, "name": "doubleClick", "kind": 2048, "kindString": "Method", "flags": { "isExported": true, "isExternal": true }, "signatures": [ { "id": 1466, "name": "doubleClick", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Double-clicks the primary mouse button." }, "type": { "type": "reference", "id": 1216, "typeArguments": [ { "type": "intrinsic", "name": "void" }, { "type": "unknown", "name": "P" }, { "type": "unknown", "name": "StringResult" } ], "name": "Command" } } ], "sources": [ { "fileName": "src/Command.ts", "line": 1378, "character": 13 } ] }, { "id": 1490, "name": "doubleTap", "kind": 2048, "kindString": "Method", "flags": { "isExported": true, "isExternal": true }, "signatures": [ { "id": 1491, "name": "doubleTap", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Performs a double-tap gesture on an element.", "tags": [ { "tag": "method", "text": "" } ] }, "parameters": [ { "id": 1492, "name": "element", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true, "isOptional": true }, "comment": { "text": "The element to double-tap.\n" }, "type": { "type": "reference", "id": 322, "name": "Element" } } ], "type": { "type": "reference", "id": 1216, "typeArguments": [ { "type": "intrinsic", "name": "void" }, { "type": "unknown", "name": "P" }, { "type": "unknown", "name": "StringResult" } ], "name": "Command" } } ], "sources": [ { "fileName": "src/Command.ts", "line": 1458, "character": 11 } ] }, { "id": 1265, "name": "end", "kind": 2048, "kindString": "Method", "flags": { "isExported": true, "isExternal": true }, "signatures": [ { "id": 1266, "name": "end", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Ends the most recent filtering operation in the current Command chain\nand returns the set of matched elements to the previous state. This is\nequivalent to the `jQuery#end` method.", "text": "```js\ncommand\n .findById('parent') // sets filter to #parent\n .findByClassName('child') // sets filter to all .child inside #parent\n .getVisibleText()\n .then(function (visibleTexts) {\n // all the visible texts from the children\n })\n .end() // resets filter to #parent\n .end(); // resets filter to nothing (the whole document)\n ```\n" }, "parameters": [ { "id": 1267, "name": "numCommandsToPop", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The number of element contexts to pop. Defaults\nto 1.\n" }, "type": { "type": "intrinsic", "name": "number" }, "defaultValue": "1" } ], "type": { "type": "reference", "id": 1216, "typeArguments": [ { "type": "intrinsic", "name": "void" }, { "type": "typeParameter", "name": "P", "default": { "type": "intrinsic", "name": "any" } }, { "type": "typeParameter", "name": "StringResult", "constraint": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } } ] }, "default": { "type": "intrinsic", "name": "string" } } ], "name": "Command" } } ], "sources": [ { "fileName": "src/Command.ts", "line": 530, "character": 5 } ] }, { "id": 1567, "name": "equals", "kind": 2048, "kindString": "Method", "flags": { "isExported": true, "isExternal": true }, "signatures": [ { "id": 1568, "name": "equals", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Determines if this element is equal to another element." }, "parameters": [ { "id": 1569, "name": "other", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reference", "id": 322, "name": "Element" } } ], "type": { "type": "reference", "id": 1216, "typeArguments": [ { "type": "intrinsic", "name": "boolean" }, { "type": "unknown", "name": "P" }, { "type": "unknown", "name": "StringResult" } ], "name": "Command" } } ], "sources": [ { "fileName": "src/Command.ts", "line": 1770, "character": 8 } ] }, { "id": 1351, "name": "execute", "kind": 2048, "kindString": "Method", "flags": { "isExported": true, "isExternal": true }, "signatures": [ { "id": 1352, "name": "execute", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Executes JavaScript code within the focused window/frame. The code\nshould return a value synchronously.", "text": "See [[Command.Command.executeAsync]] to execute code that returns values\nasynchronously.\n", "returns": "The value returned by the remote code. Only values that can be\nserialised to JSON, plus DOM elements, can be returned.\n" }, "typeParameter": [ { "id": 1353, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": { "isExported": true } } ], "parameters": [ { "id": 1354, "name": "script", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The code to execute. This function will always be\nconverted to a string, sent to the remote environment, and reassembled\nas a new anonymous function on the remote end. This means that you\ncannot access any variables through closure. If your code needs to get\ndata from variables on the local end, they should be passed using\n`args`.\n" }, "type": { "type": "union", "types": [ { "type": "reference", "name": "Function" }, { "type": "intrinsic", "name": "string" } ] } }, { "id": 1355, "name": "args", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true, "isOptional": true }, "comment": { "text": "An array of arguments that will be passed to the executed\ncode. Only values that can be serialised to JSON, plus [[Element]]\nobjects, can be specified as arguments.\n" }, "type": { "type": "array", "elementType": { "type": "intrinsic", "name": "any" } } } ], "type": { "type": "reference", "id": 1216, "typeArguments": [ { "type": "unknown", "name": "T" }, { "type": "unknown", "name": "P" }, { "type": "unknown", "name": "StringResult" } ], "name": "Command" } } ], "sources": [ { "fileName": "src/Command.ts", "line": 960, "character": 9 } ] }, { "id": 1356, "name": "executeAsync", "kind": 2048, "kindString": "Method", "flags": { "isExported": true, "isExternal": true }, "signatures": [ { "id": 1357, "name": "executeAsync", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Executes JavaScript code within the focused window/frame. The code must\ninvoke the provided callback in order to signal that it has completed\nexecution.", "text": "See [[Command.Command.execute]] to execute code that returns values\nsynchronously.\n\nSee [[Command.Command.setExecuteAsyncTimeout]] to set the time until an\nasynchronous script is considered timed out.\n", "returns": "The value returned by the remote code. Only values that can be\nserialised to JSON, plus DOM elements, can be returned.\n" }, "typeParameter": [ { "id": 1358, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": { "isExported": true } } ], "parameters": [ { "id": 1359, "name": "script", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The code to execute. This function will always be\nconverted to a string, sent to the remote environment, and reassembled\nas a new anonymous function on the remote end. This means that you\ncannot access any variables through closure. If your code needs to get\ndata from variables on the local end, they should be passed using\n`args`.\n" }, "type": { "type": "union", "types": [ { "type": "reference", "name": "Function" }, { "type": "intrinsic", "name": "string" } ] } }, { "id": 1360, "name": "args", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true, "isOptional": true }, "comment": { "text": "An array of arguments that will be passed to the executed\ncode. Only values that can be serialised to JSON, plus [[Element]]\nobjects, can be specified as arguments. In addition to these arguments,\na callback function will always be passed as the final argument to the\nfunction specified in `script`. This callback function must be invoked\nin order to signal that execution has completed. The return value of the\nexecution, if any, should be passed to this callback function.\n" }, "type": { "type": "array", "elementType": { "type": "intrinsic", "name": "any" } } } ], "type": { "type": "reference", "id": 1216, "typeArguments": [ { "type": "unknown", "name": "T" }, { "type": "unknown", "name": "P" }, { "type": "unknown", "name": "StringResult" } ], "name": "Command" } } ], "sources": [ { "fileName": "src/Command.ts", "line": 993, "character": 14 } ] }, { "id": 1291, "name": "finally", "kind": 2048, "kindString": "Method", "flags": { "isExported": true, "isExternal": true }, "signatures": [ { "id": 1292, "name": "finally", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Adds a callback to be invoked once the previously chained operations\nhave resolved." }, "parameters": [ { "id": 1293, "name": "callback", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reflection", "declaration": { "id": 1294, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "signatures": [ { "id": 1295, "name": "__call", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "void" } } ], "sources": [ { "fileName": "src/Command.ts", "line": 697, "character": 19 } ] } } } ], "type": { "type": "unknown", "name": "this" } } ], "sources": [ { "fileName": "src/Command.ts", "line": 697, "character": 9 } ] }, { "id": 1298, "name": "find", "kind": 2048, "kindString": "Method", "flags": { "isExported": true, "isExternal": true }, "signatures": [ { "id": 1299, "name": "find", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 1300, "name": "strategy", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reference", "id": 273, "name": "Strategy" } }, { "id": 1301, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "id": 1216, "typeArguments": [ { "type": "reference", "id": 322, "name": "Element" }, { "type": "unknown", "name": "P" }, { "type": "intrinsic", "name": "string" } ], "name": "Command" }, "overwrites": { "type": "reference", "id": 149, "name": "Locator.find" } } ], "sources": [ { "fileName": "src/Command.ts", "line": 712, "character": 6 } ], "overwrites": { "type": "reference", "id": 149, "name": "Locator.find" } }, { "id": 1302, "name": "findAll", "kind": 2048, "kindString": "Method", "flags": { "isExported": true, "isExternal": true }, "signatures": [ { "id": 1303, "name": "findAll", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 1304, "name": "strategy", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reference", "id": 273, "name": "Strategy" } }, { "id": 1305, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "id": 1216, "typeArguments": [ { "type": "array", "elementType": { "type": "reference", "id": 322, "name": "Element" } }, { "type": "unknown", "name": "P" }, { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } } ], "name": "Command" }, "overwrites": { "type": "reference", "id": 153, "name": "Locator.findAll" } } ], "sources": [ { "fileName": "src/Command.ts", "line": 716, "character": 9 } ], "overwrites": { "type": "reference", "id": 153, "name": "Locator.findAll" } }, { "id": 1609, "name": "findAllByClassName", "kind": 2048, "kindString": "Method", "flags": { "isExported": true, "isExternal": true }, "signatures": [ { "id": 1610, "name": "findAllByClassName", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Gets all elements inside this element matching the given CSS class name." }, "parameters": [ { "id": 1611, "name": "className", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The CSS class name to search for.\n" }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "unknown", "name": "L" }, "inheritedFrom": { "type": "reference", "id": 189, "name": "Locator.findAllByClassName" } } ], "sources": [ { "fileName": "src/lib/Locator.ts", "line": 106, "character": 20 } ], "inheritedFrom": { "type": "reference", "id": 189, "name": "Locator.findAllByClassName" } }, { "id": 1612, "name": "findAllByCssSelector", "kind": 2048, "kindString": "Method", "flags": { "isExported": true, "isExternal": true }, "signatures": [ { "id": 1613, "name": "findAllByCssSelector", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Gets all elements inside this element matching the given CSS selector." }, "parameters": [ { "id": 1614, "name": "selector", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The CSS selector to search for.\n" }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "unknown", "name": "L" }, "inheritedFrom": { "type": "reference", "id": 192, "name": "Locator.findAllByCssSelector" } } ], "sources": [ { "fileName": "src/lib/Locator.ts", "line": 115, "character": 22 } ], "inheritedFrom": { "type": "reference", "id": 192, "name": "Locator.findAllByCssSelector" } }, { "id": 1618, "name": "findAllByLinkText", "kind": 2048, "kindString": "Method", "flags": { "isExported": true, "isExternal": true }, "signatures": [ { "id": 1619, "name": "findAllByLinkText", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Gets all elements inside this element matching the given\ncase-insensitive link text." }, "parameters": [ { "id": 1620, "name": "text", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The link text of the element.\n" }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "unknown", "name": "L" }, "inheritedFrom": { "type": "reference", "id": 198, "name": "Locator.findAllByLinkText" } } ], "sources": [ { "fileName": "src/lib/Locator.ts", "line": 134, "character": 19 } ], "inheritedFrom": { "type": "reference", "id": 198, "name": "Locator.findAllByLinkText" } }, { "id": 1615, "name": "findAllByName", "kind": 2048, "kindString": "Method", "flags": { "isExported": true, "isExternal": true }, "signatures": [ { "id": 1616, "name": "findAllByName", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Gets all elements inside this element matching the given name attribute." }, "parameters": [ { "id": 1617, "name": "name", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The name of the element.\n" }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "unknown", "name": "L" }, "inheritedFrom": { "type": "reference", "id": 195, "name": "Locator.findAllByName" } } ], "sources": [ { "fileName": "src/lib/Locator.ts", "line": 124, "character": 15 } ], "inheritedFrom": { "type": "reference", "id": 195, "name": "Locator.findAllByName" } }, { "id": 1621, "name": "findAllByPartialLinkText", "kind": 2048, "kindString": "Method", "flags": { "isExported": true, "isExternal": true }, "signatures": [ { "id": 1622, "name": "findAllByPartialLinkText", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Gets all elements inside this element partially matching the given\ncase-insensitive link text." }, "parameters": [ { "id": 1623, "name": "text", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The partial link text of the element.\n" }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "unknown", "name": "L" }, "inheritedFrom": { "type": "reference", "id": 201, "name": "Locator.findAllByPartialLinkText" } } ], "sources": [ { "fileName": "src/lib/Locator.ts", "line": 144, "character": 26 } ], "inheritedFrom": { "type": "reference", "id": 201, "name": "Locator.findAllByPartialLinkText" } }, { "id": 1624, "name": "findAllByTagName", "kind": 2048, "kindString": "Method", "flags": { "isExported": true, "isExternal": true }, "signatures": [ { "id": 1625, "name": "findAllByTagName", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Gets all elements inside this element matching the given HTML tag name." }, "parameters": [ { "id": 1626, "name": "tagName", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The tag name of the element.\n" }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "unknown", "name": "L" }, "inheritedFrom": { "type": "reference", "id": 204, "name": "Locator.findAllByTagName" } } ], "sources": [ { "fileName": "src/lib/Locator.ts", "line": 153, "character": 18 } ], "inheritedFrom": { "type": "reference", "id": 204, "name": "Locator.findAllByTagName" } }, { "id": 1627, "name": "findAllByXpath", "kind": 2048, "kindString": "Method", "flags": { "isExported": true, "isExternal": true }, "signatures": [ { "id": 1628, "name": "findAllByXpath", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Gets all elements inside this element matching the given XPath selector." }, "parameters": [ { "id": 1629, "name": "path", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The XPath selector to search for.\n" }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "unknown", "name": "L" }, "inheritedFrom": { "type": "reference", "id": 207, "name": "Locator.findAllByXpath" } } ], "sources": [ { "fileName": "src/lib/Locator.ts", "line": 162, "character": 16 } ], "inheritedFrom": { "type": "reference", "id": 207, "name": "Locator.findAllByXpath" } }, { "id": 1585, "name": "findByClassName", "kind": 2048, "kindString": "Method", "flags": { "isExported": true, "isExternal": true }, "signatures": [ { "id": 1586, "name": "findByClassName", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Gets the first element inside this element matching the given CSS class\nname." }, "parameters": [ { "id": 1587, "name": "className", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The CSS class name to search for.\n" }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "unknown", "name": "E" }, "inheritedFrom": { "type": "reference", "id": 165, "name": "Locator.findByClassName" } } ], "sources": [ { "fileName": "src/lib/Locator.ts", "line": 28, "character": 17 } ], "inheritedFrom": { "type": "reference", "id": 165, "name": "Locator.findByClassName" } }, { "id": 1588, "name": "findByCssSelector", "kind": 2048, "kindString": "Method", "flags": { "isExported": true, "isExternal": true }, "signatures": [ { "id": 1589, "name": "findByCssSelector", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Gets the first element inside this element matching the given CSS\nselector." }, "parameters": [ { "id": 1590, "name": "selector", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The CSS selector to search for.\n" }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "unknown", "name": "E" }, "inheritedFrom": { "type": "reference", "id": 168, "name": "Locator.findByCssSelector" } } ], "sources": [ { "fileName": "src/lib/Locator.ts", "line": 38, "character": 19 } ], "inheritedFrom": { "type": "reference", "id": 168, "name": "Locator.findByCssSelector" } }, { "id": 1591, "name": "findById", "kind": 2048, "kindString": "Method", "flags": { "isExported": true, "isExternal": true }, "signatures": [ { "id": 1592, "name": "findById", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Gets the first element inside this element matching the given ID." }, "parameters": [ { "id": 1593, "name": "id", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The ID of the element.\n" }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "unknown", "name": "E" }, "inheritedFrom": { "type": "reference", "id": 171, "name": "Locator.findById" } } ], "sources": [ { "fileName": "src/lib/Locator.ts", "line": 47, "character": 10 } ], "inheritedFrom": { "type": "reference", "id": 171, "name": "Locator.findById" } }, { "id": 1597, "name": "findByLinkText", "kind": 2048, "kindString": "Method", "flags": { "isExported": true, "isExternal": true }, "signatures": [ { "id": 1598, "name": "findByLinkText", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Gets the first element inside this element matching the given\ncase-insensitive link text." }, "parameters": [ { "id": 1599, "name": "text", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The link text of the element.\n" }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "unknown", "name": "E" }, "inheritedFrom": { "type": "reference", "id": 177, "name": "Locator.findByLinkText" } } ], "sources": [ { "fileName": "src/lib/Locator.ts", "line": 67, "character": 16 } ], "inheritedFrom": { "type": "reference", "id": 177, "name": "Locator.findByLinkText" } }, { "id": 1594, "name": "findByName", "kind": 2048, "kindString": "Method", "flags": { "isExported": true, "isExternal": true }, "signatures": [ { "id": 1595, "name": "findByName", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Gets the first element inside this element matching the given name\nattribute." }, "parameters": [ { "id": 1596, "name": "name", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The name of the element.\n" }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "unknown", "name": "E" }, "inheritedFrom": { "type": "reference", "id": 174, "name": "Locator.findByName" } } ], "sources": [ { "fileName": "src/lib/Locator.ts", "line": 57, "character": 12 } ], "inheritedFrom": { "type": "reference", "id": 174, "name": "Locator.findByName" } }, { "id": 1600, "name": "findByPartialLinkText", "kind": 2048, "kindString": "Method", "flags": { "isExported": true, "isExternal": true }, "signatures": [ { "id": 1601, "name": "findByPartialLinkText", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Gets the first element inside this element partially matching the given\ncase-insensitive link text." }, "parameters": [ { "id": 1602, "name": "text", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The partial link text of the element.\n" }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "unknown", "name": "E" }, "inheritedFrom": { "type": "reference", "id": 180, "name": "Locator.findByPartialLinkText" } } ], "sources": [ { "fileName": "src/lib/Locator.ts", "line": 77, "character": 23 } ], "inheritedFrom": { "type": "reference", "id": 180, "name": "Locator.findByPartialLinkText" } }, { "id": 1603, "name": "findByTagName", "kind": 2048, "kindString": "Method", "flags": { "isExported": true, "isExternal": true }, "signatures": [ { "id": 1604, "name": "findByTagName", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Gets the first element inside this element matching the given HTML tag\nname." }, "parameters": [ { "id": 1605, "name": "tagName", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The tag name of the element.\n" }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "unknown", "name": "E" }, "inheritedFrom": { "type": "reference", "id": 183, "name": "Locator.findByTagName" } } ], "sources": [ { "fileName": "src/lib/Locator.ts", "line": 87, "character": 15 } ], "inheritedFrom": { "type": "reference", "id": 183, "name": "Locator.findByTagName" } }, { "id": 1606, "name": "findByXpath", "kind": 2048, "kindString": "Method", "flags": { "isExported": true, "isExternal": true }, "signatures": [ { "id": 1607, "name": "findByXpath", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Gets the first element inside this element matching the given XPath\nselector." }, "parameters": [ { "id": 1608, "name": "path", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The XPath selector to search for.\n" }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "unknown", "name": "E" }, "inheritedFrom": { "type": "reference", "id": 186, "name": "Locator.findByXpath" } } ], "sources": [ { "fileName": "src/lib/Locator.ts", "line": 97, "character": 13 } ], "inheritedFrom": { "type": "reference", "id": 186, "name": "Locator.findByXpath" } }, { "id": 1306, "name": "findDisplayed", "kind": 2048, "kindString": "Method", "flags": { "isExported": true, "isExternal": true }, "signatures": [ { "id": 1307, "name": "findDisplayed", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 1308, "name": "strategy", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reference", "id": 273, "name": "Strategy" } }, { "id": 1309, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "id": 1216, "typeArguments": [ { "type": "reference", "id": 322, "name": "Element" }, { "type": "unknown", "name": "P" }, { "type": "intrinsic", "name": "string" } ], "name": "Command" }, "overwrites": { "type": "reference", "id": 157, "name": "Locator.findDisplayed" } } ], "sources": [ { "fileName": "src/Command.ts", "line": 720, "character": 15 } ], "overwrites": { "type": "reference", "id": 157, "name": "Locator.findDisplayed" } }, { "id": 1630, "name": "findDisplayedByClassName", "kind": 2048, "kindString": "Method", "flags": { "isExported": true, "isExternal": true }, "signatures": [ { "id": 1631, "name": "findDisplayedByClassName", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Gets the first [[Element.isDisplayed|displayed]] element inside this\nelement matching the given CSS class name. This is inherently slower\nthan [[Element.find]], so should only be used in cases where the\nvisibility of an element cannot be ensured in advance.", "tags": [ { "tag": "since", "text": "1.6" } ] }, "parameters": [ { "id": 1632, "name": "className", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The CSS class name to search for.\n" }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "unknown", "name": "E" }, "inheritedFrom": { "type": "reference", "id": 210, "name": "Locator.findDisplayedByClassName" } } ], "sources": [ { "fileName": "src/lib/Locator.ts", "line": 175, "character": 26 } ], "inheritedFrom": { "type": "reference", "id": 210, "name": "Locator.findDisplayedByClassName" } }, { "id": 1633, "name": "findDisplayedByCssSelector", "kind": 2048, "kindString": "Method", "flags": { "isExported": true, "isExternal": true }, "signatures": [ { "id": 1634, "name": "findDisplayedByCssSelector", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Gets the first [[Element.isDisplayed|displayed]] element inside this\nelement matching the given CSS selector. This is inherently slower than\n[[Element.find]], so should only be used in cases where the visibility\nof an element cannot be ensured in advance.", "tags": [ { "tag": "since", "text": "1.6" } ] }, "parameters": [ { "id": 1635, "name": "selector", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The CSS selector to search for.\n" }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "unknown", "name": "E" }, "inheritedFrom": { "type": "reference", "id": 213, "name": "Locator.findDisplayedByCssSelector" } } ], "sources": [ { "fileName": "src/lib/Locator.ts", "line": 188, "character": 28 } ], "inheritedFrom": { "type": "reference", "id": 213, "name": "Locator.findDisplayedByCssSelector" } }, { "id": 1636, "name": "findDisplayedById", "kind": 2048, "kindString": "Method", "flags": { "isExported": true, "isExternal": true }, "signatures": [ { "id": 1637, "name": "findDisplayedById", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Gets the first [[Element.isDisplayed|displayed]] element inside this\nelement matching the given ID. This is inherently slower than\n[[Element.find]], so should only be used in cases where the visibility\nof an element cannot be ensured in advance.", "tags": [ { "tag": "since", "text": "1.6" } ] }, "parameters": [ { "id": 1638, "name": "id", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The ID of the element.\n" }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "unknown", "name": "E" }, "inheritedFrom": { "type": "reference", "id": 216, "name": "Locator.findDisplayedById" } } ], "sources": [ { "fileName": "src/lib/Locator.ts", "line": 201, "character": 19 } ], "inheritedFrom": { "type": "reference", "id": 216, "name": "Locator.findDisplayedById" } }, { "id": 1642, "name": "findDisplayedByLinkText", "kind": 2048, "kindString": "Method", "flags": { "isExported": true, "isExternal": true }, "signatures": [ { "id": 1643, "name": "findDisplayedByLinkText", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Gets the first [[Element.isDisplayed|displayed]] element inside this\nelement matching the given case-insensitive link text. This is\ninherently slower than [[Element.find]], so should only be used in cases\nwhere the visibility of an element cannot be ensured in advance.", "tags": [ { "tag": "since", "text": "1.6" } ] }, "parameters": [ { "id": 1644, "name": "text", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The link text of the element.\n" }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "unknown", "name": "E" }, "inheritedFrom": { "type": "reference", "id": 222, "name": "Locator.findDisplayedByLinkText" } } ], "sources": [ { "fileName": "src/lib/Locator.ts", "line": 227, "character": 25 } ], "inheritedFrom": { "type": "reference", "id": 222, "name": "Locator.findDisplayedByLinkText" } }, { "id": 1639, "name": "findDisplayedByName", "kind": 2048, "kindString": "Method", "flags": { "isExported": true, "isExternal": true }, "signatures": [ { "id": 1640, "name": "findDisplayedByName", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Gets the first [[Element.isDisplayed|displayed]] element inside this\nelement matching the given name attribute. This is inherently slower\nthan [[Element.find]], so should only be used in cases where the\nvisibility of an element cannot be ensured in advance.", "tags": [ { "tag": "since", "text": "1.6" } ] }, "parameters": [ { "id": 1641, "name": "name", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The name of the element.\n" }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "unknown", "name": "E" }, "inheritedFrom": { "type": "reference", "id": 219, "name": "Locator.findDisplayedByName" } } ], "sources": [ { "fileName": "src/lib/Locator.ts", "line": 214, "character": 21 } ], "inheritedFrom": { "type": "reference", "id": 219, "name": "Locator.findDisplayedByName" } }, { "id": 1645, "name": "findDisplayedByPartialLinkText", "kind": 2048, "kindString": "Method", "flags": { "isExported": true, "isExternal": true }, "signatures": [ { "id": 1646, "name": "findDisplayedByPartialLinkText", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Gets the first [[Element.isDisplayed|displayed]] element inside this\nelement partially matching the given case-insensitive link text. This is\ninherently slower than [[Element.find]], so should only be used in cases\nwhere the visibility of an element cannot be ensured in advance.", "tags": [ { "tag": "since", "text": "1.6" } ] }, "parameters": [ { "id": 1647, "name": "text", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The partial link text of the element.\n" }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "unknown", "name": "E" }, "inheritedFrom": { "type": "reference", "id": 225, "name": "Locator.findDisplayedByPartialLinkText" } } ], "sources": [ { "fileName": "src/lib/Locator.ts", "line": 240, "character": 32 } ], "inheritedFrom": { "type": "reference", "id": 225, "name": "Locator.findDisplayedByPartialLinkText" } }, { "id": 1648, "name": "findDisplayedByTagName", "kind": 2048, "kindString": "Method", "flags": { "isExported": true, "isExternal": true }, "signatures": [ { "id": 1649, "name": "findDisplayedByTagName", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Gets the first [[Element.isDisplayed|displayed]] element inside this\nelement matching the given HTML tag name. This is inherently slower than\n[[Element.find]], so should only be used in cases where the visibility\nof an element cannot be ensured in advance.", "tags": [ { "tag": "since", "text": "1.6" } ] }, "parameters": [ { "id": 1650, "name": "tagName", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The tag name of the element.\n" }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "unknown", "name": "E" }, "inheritedFrom": { "type": "reference", "id": 228, "name": "Locator.findDisplayedByTagName" } } ], "sources": [ { "fileName": "src/lib/Locator.ts", "line": 253, "character": 24 } ], "inheritedFrom": { "type": "reference", "id": 228, "name": "Locator.findDisplayedByTagName" } }, { "id": 1651, "name": "findDisplayedByXpath", "kind": 2048, "kindString": "Method", "flags": { "isExported": true, "isExternal": true }, "signatures": [ { "id": 1652, "name": "findDisplayedByXpath", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Gets the first [[Element.isDisplayed|displayed]] element inside this\nelement matching the given XPath selector. This is inherently slower\nthan [[Element.find]], so should only be used in cases where the\nvisibility of an element cannot be ensured in advance.", "tags": [ { "tag": "since", "text": "1.6" } ] }, "parameters": [ { "id": 1653, "name": "path", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The XPath selector to search for.\n" }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "unknown", "name": "E" }, "inheritedFrom": { "type": "reference", "id": 231, "name": "Locator.findDisplayedByXpath" } } ], "sources": [ { "fileName": "src/lib/Locator.ts", "line": 266, "character": 22 } ], "inheritedFrom": { "type": "reference", "id": 231, "name": "Locator.findDisplayedByXpath" } }, { "id": 1496, "name": "flickFinger", "kind": 2048, "kindString": "Method", "flags": { "isExported": true, "isExternal": true }, "signatures": [ { "id": 1497, "name": "flickFinger", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Flicks a finger. Note that this method is currently badly specified and\nhighly dysfunctional and is only provided for the sake of completeness." }, "parameters": [ { "id": 1498, "name": "element", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The element where the flick should start." }, "type": { "type": "reference", "id": 322, "name": "Element" } }, { "id": 1499, "name": "xOffset", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The x-offset in pixels to flick by." }, "type": { "type": "intrinsic", "name": "number" } }, { "id": 1500, "name": "yOffset", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The x-offset in pixels to flick by." }, "type": { "type": "intrinsic", "name": "number" } }, { "id": 1501, "name": "speed", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true, "isOptional": true }, "comment": { "text": "The speed of the flick, in pixels per *second*. Most human\nflicks are 100–200ms, so this value will be higher than expected.\n" }, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "number" } ] } } ], "type": { "type": "reference", "id": 1216, "typeArguments": [ { "type": "intrinsic", "name": "void" }, { "type": "typeParameter", "name": "P", "default": { "type": "intrinsic", "name": "any" } }, { "type": "typeParameter", "name": "StringResult", "constraint": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } } ] }, "default": { "type": "intrinsic", "name": "string" } } ], "name": "Command" } }, { "id": 1502, "name": "flickFinger", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 1503, "name": "xOffset", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "number" } }, { "id": 1504, "name": "yOffset", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "number" } }, { "id": 1505, "name": "speed", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true, "isOptional": true }, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "number" } ] } } ], "type": { "type": "reference", "id": 1216, "typeArguments": [ { "type": "intrinsic", "name": "void" }, { "type": "typeParameter", "name": "P", "default": { "type": "intrinsic", "name": "any" } }, { "type": "typeParameter", "name": "StringResult", "constraint": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } } ] }, "default": { "type": "intrinsic", "name": "string" } } ], "name": "Command" } } ], "sources": [ { "fileName": "src/Command.ts", "line": 1482, "character": 13 }, { "fileName": "src/Command.ts", "line": 1488, "character": 13 }, { "fileName": "src/Command.ts", "line": 1493, "character": 13 } ] }, { "id": 1342, "name": "get", "kind": 2048, "kindString": "Method", "flags": { "isExported": true, "isExternal": true }, "signatures": [ { "id": 1343, "name": "get", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Navigates the focused window/frame to a new URL." }, "parameters": [ { "id": 1344, "name": "url", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "id": 1216, "typeArguments": [ { "type": "intrinsic", "name": "void" }, { "type": "unknown", "name": "P" }, { "type": "unknown", "name": "StringResult" } ], "name": "Command" } } ], "sources": [ { "fileName": "src/Command.ts", "line": 912, "character": 5 } ] }, { "id": 1429, "name": "getActiveElement", "kind": 2048, "kindString": "Method", "flags": { "isExported": true, "isExternal": true }, "signatures": [ { "id": 1430, "name": "getActiveElement", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Gets the currently focused element from the focused window/frame." }, "type": { "type": "reference", "id": 1216, "typeArguments": [ { "type": "reference", "id": 322, "name": "Element" }, { "type": "unknown", "name": "P" }, { "type": "unknown", "name": "StringResult" } ], "name": "Command" } } ], "sources": [ { "fileName": "src/Command.ts", "line": 1237, "character": 18 } ] }, { "id": 1365, "name": "getActiveImeEngine", "kind": 2048, "kindString": "Method", "flags": { "isExported": true, "isExternal": true }, "signatures": [ { "id": 1366, "name": "getActiveImeEngine", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Gets the currently active input method editor for the remote environment.\nAs of April 2014, no known remote environments support IME functions." }, "type": { "type": "reference", "id": 1216, "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "unknown", "name": "P" }, { "type": "unknown", "name": "StringResult" } ], "name": "Command" } } ], "sources": [ { "fileName": "src/Command.ts", "line": 1017, "character": 20 } ] }, { "id": 1439, "name": "getAlertText", "kind": 2048, "kindString": "Method", "flags": { "isExported": true, "isExternal": true }, "signatures": [ { "id": 1440, "name": "getAlertText", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Gets the text displayed in the currently active alert pop-up." }, "type": { "type": "reference", "id": 1216, "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "unknown", "name": "P" }, { "type": "unknown", "name": "StringResult" } ], "name": "Command" } } ], "sources": [ { "fileName": "src/Command.ts", "line": 1277, "character": 14 } ] }, { "id": 1338, "name": "getAllWindowHandles", "kind": 2048, "kindString": "Method", "flags": { "isExported": true, "isExternal": true }, "signatures": [ { "id": 1339, "name": "getAllWindowHandles", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Gets a list of identifiers for all currently open windows." }, "type": { "type": "reference", "id": 1216, "typeArguments": [ { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } }, { "type": "unknown", "name": "P" }, { "type": "unknown", "name": "StringResult" } ], "name": "Command" } } ], "sources": [ { "fileName": "src/Command.ts", "line": 898, "character": 21 } ] }, { "id": 1516, "name": "getApplicationCacheStatus", "kind": 2048, "kindString": "Method", "flags": { "isExported": true, "isExternal": true }, "signatures": [ { "id": 1517, "name": "getApplicationCacheStatus", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Gets the current state of the HTML5 application cache for the current\npage.", "returns": "The cache status. One of 0 (uncached), 1 (cached/idle), 2\n(checking), 3 (downloading), 4 (update ready), 5 (obsolete).\n" }, "type": { "type": "reference", "id": 1216, "typeArguments": [ { "type": "intrinsic", "name": "number" }, { "type": "unknown", "name": "P" }, { "type": "unknown", "name": "StringResult" } ], "name": "Command" } } ], "sources": [ { "fileName": "src/Command.ts", "line": 1552, "character": 27 } ] }, { "id": 1559, "name": "getAttribute", "kind": 2048, "kindString": "Method", "flags": { "isExported": true, "isExternal": true }, "signatures": [ { "id": 1560, "name": "getAttribute", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Gets an attribute of the element.", "text": "See [[Element.Element.getProperty]] to retrieve an element property.\n", "returns": "The value of the attribute, or `null` if no such attribute\nexists.\n" }, "typeParameter": [ { "id": 1561, "name": "S", "kind": 131072, "kindString": "Type parameter", "flags": { "isExported": true } } ], "parameters": [ { "id": 1562, "name": "name", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The name of the attribute." }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "id": 1216, "typeArguments": [ { "type": "unknown", "name": "S" }, { "type": "unknown", "name": "P" }, { "type": "unknown", "name": "StringResult" } ], "name": "Command" } } ], "sources": [ { "fileName": "src/Command.ts", "line": 1751, "character": 14 } ] }, { "id": 1363, "name": "getAvailableImeEngines", "kind": 2048, "kindString": "Method", "flags": { "isExported": true, "isExternal": true }, "signatures": [ { "id": 1364, "name": "getAvailableImeEngines", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Gets a list of input method editor engines available to the remote\nenvironment. As of April 2014, no known remote environments support IME\nfunctions." }, "type": { "type": "reference", "id": 1216, "typeArguments": [ { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } }, { "type": "unknown", "name": "P" }, { "type": "unknown", "name": "StringResult" } ], "name": "Command" } } ], "sources": [ { "fileName": "src/Command.ts", "line": 1009, "character": 24 } ] }, { "id": 1514, "name": "getAvailableLogTypes", "kind": 2048, "kindString": "Method", "flags": { "isExported": true, "isExternal": true }, "signatures": [ { "id": 1515, "name": "getAvailableLogTypes", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Gets the types of logs that are currently available for retrieval from\nthe remote environment." }, "type": { "type": "reference", "id": 1216, "typeArguments": [ { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } }, { "type": "unknown", "name": "P" }, { "type": "unknown", "name": "StringResult" } ], "name": "Command" } } ], "sources": [ { "fileName": "src/Command.ts", "line": 1541, "character": 22 } ] }, { "id": 1582, "name": "getComputedStyle", "kind": 2048, "kindString": "Method", "flags": { "isExported": true, "isExternal": true }, "signatures": [ { "id": 1583, "name": "getComputedStyle", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Gets a CSS computed property value for the element." }, "parameters": [ { "id": 1584, "name": "propertyName", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The CSS property to retrieve. This argument must be\nhyphenated, *not* camel-case.\n" }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "id": 1216, "typeArguments": [ { "type": "unknown", "name": "StringResult" }, { "type": "unknown", "name": "P" }, { "type": "unknown", "name": "StringResult" } ], "name": "Command" } } ], "sources": [ { "fileName": "src/Command.ts", "line": 1815, "character": 18 } ] }, { "id": 1415, "name": "getCookies", "kind": 2048, "kindString": "Method", "flags": { "isExported": true, "isExternal": true }, "signatures": [ { "id": 1416, "name": "getCookies", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Gets all cookies set on the current page." }, "type": { "type": "reference", "id": 1216, "typeArguments": [ { "type": "array", "elementType": { "type": "reference", "id": 617, "name": "WebDriverCookie" } }, { "type": "unknown", "name": "P" }, { "type": "unknown", "name": "StringResult" } ], "name": "Command" } } ], "sources": [ { "fileName": "src/Command.ts", "line": 1190, "character": 12 } ] }, { "id": 1340, "name": "getCurrentUrl", "kind": 2048, "kindString": "Method", "flags": { "isExported": true, "isExternal": true }, "signatures": [ { "id": 1341, "name": "getCurrentUrl", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Gets the URL that is loaded in the focused window/frame." }, "type": { "type": "reference", "id": 1216, "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "unknown", "name": "P" }, { "type": "unknown", "name": "StringResult" } ], "name": "Command" } } ], "sources": [ { "fileName": "src/Command.ts", "line": 905, "character": 15 } ] }, { "id": 1336, "name": "getCurrentWindowHandle", "kind": 2048, "kindString": "Method", "flags": { "isExported": true, "isExternal": true }, "signatures": [ { "id": 1337, "name": "getCurrentWindowHandle", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Gets the identifier for the window that is currently focused.", "returns": "A window handle identifier that can be used with other window\nhandling functions.\n" }, "type": { "type": "reference", "id": 1216, "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "unknown", "name": "P" }, { "type": "unknown", "name": "StringResult" } ], "name": "Command" } } ], "sources": [ { "fileName": "src/Command.ts", "line": 891, "character": 24 } ] }, { "id": 1524, "name": "getExecuteAsyncTimeout", "kind": 2048, "kindString": "Method", "flags": { "isExported": true, "isExternal": true }, "signatures": [ { "id": 1525, "name": "getExecuteAsyncTimeout", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Gets the timeout for [[Command.Command.executeAsync]] calls." }, "type": { "type": "reference", "id": 1216, "typeArguments": [ { "type": "intrinsic", "name": "number" }, { "type": "unknown", "name": "P" }, { "type": "unknown", "name": "StringResult" } ], "name": "Command" } } ], "sources": [ { "fileName": "src/Command.ts", "line": 1581, "character": 24 } ] }, { "id": 1529, "name": "getFindTimeout", "kind": 2048, "kindString": "Method", "flags": { "isExported": true, "isExternal": true }, "signatures": [ { "id": 1530, "name": "getFindTimeout", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Gets the timeout for [[Command.Command.find]] calls." }, "type": { "type": "reference", "id": 1216, "typeArguments": [ { "type": "intrinsic", "name": "number" }, { "type": "unknown", "name": "P" }, { "type": "unknown", "name": "StringResult" } ], "name": "Command" } } ], "sources": [ { "fileName": "src/Command.ts", "line": 1597, "character": 16 } ] }, { "id": 1506, "name": "getGeolocation", "kind": 2048, "kindString": "Method", "flags": { "isExported": true, "isExternal": true }, "signatures": [ { "id": 1507, "name": "getGeolocation", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Gets the current geographical location of the remote environment.", "returns": "a [[interfaces.Geolocation]] value with latitude and longitude\nspecified using standard WGS84 decimal latitude/longitude. Altitude is\nspecified as meters above the WGS84 ellipsoid. Not all environments\nsupport altitude.\n" }, "type": { "type": "reference", "id": 1216, "typeArguments": [ { "type": "reference", "id": 609, "name": "Geolocation" }, { "type": "unknown", "name": "P" }, { "type": "unknown", "name": "StringResult" } ], "name": "Command" } } ], "sources": [ { "fileName": "src/Command.ts", "line": 1505, "character": 16 } ] }, { "id": 1511, "name": "getLogsFor", "kind": 2048, "kindString": "Method", "flags": { "isExported": true, "isExternal": true }, "signatures": [ { "id": 1512, "name": "getLogsFor", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Gets all logs from the remote environment of the given type. The logs in\nthe remote environment are cleared once they have been retrieved.", "returns": "An array of log entry objects. Timestamps in log entries are\nUnix timestamps, in seconds.\n" }, "parameters": [ { "id": 1513, "name": "type", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The type of log entries to retrieve. Available log types\ndiffer between remote environments. Use\n[[Command.Command.getAvailableLogTypes]] to learn what log types are\ncurrently available. Not all environments support all possible log\ntypes.\n" }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "id": 1216, "typeArguments": [ { "type": "array", "elementType": { "type": "reference", "id": 613, "name": "LogEntry" } }, { "type": "unknown", "name": "P" }, { "type": "unknown", "name": "StringResult" } ], "name": "Command" } } ], "sources": [ { "fileName": "src/Command.ts", "line": 1533, "character": 12 } ] }, { "id": 1434, "name": "getOrientation", "kind": 2048, "kindString": "Method", "flags": { "isExported": true, "isExternal": true }, "signatures": [ { "id": 1435, "name": "getOrientation", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Gets the current screen orientation." }, "type": { "type": "reference", "id": 1216, "typeArguments": [ { "type": "union", "types": [ { "type": "stringLiteral", "value": "portrait" }, { "type": "stringLiteral", "value": "landscape" } ] }, { "type": "unknown", "name": "P" }, { "type": "unknown", "name": "StringResult" } ], "name": "Command" } } ], "sources": [ { "fileName": "src/Command.ts", "line": 1261, "character": 16 } ] }, { "id": 1534, "name": "getPageLoadTimeout", "kind": 2048, "kindString": "Method", "flags": { "isExported": true, "isExternal": true }, "signatures": [ { "id": 1535, "name": "getPageLoadTimeout", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Gets the timeout for [[Command.Command.get]] calls." }, "type": { "type": "reference", "id": 1216, "typeArguments": [ { "type": "intrinsic", "name": "number" }, { "type": "unknown", "name": "P" }, { "type": "unknown", "name": "StringResult" } ], "name": "Command" } } ], "sources": [ { "fileName": "src/Command.ts", "line": 1613, "character": 20 } ] }, { "id": 1425, "name": "getPageSource", "kind": 2048, "kindString": "Method", "flags": { "isExported": true, "isExternal": true }, "signatures": [ { "id": 1426, "name": "getPageSource", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Gets the HTML loaded in the focused window/frame. This markup is\nserialised by the remote environment so may not exactly match the HTML\nprovided by the Web server." }, "type": { "type": "reference", "id": 1216, "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "unknown", "name": "P" }, { "type": "unknown", "name": "StringResult" } ], "name": "Command" } } ], "sources": [ { "fileName": "src/Command.ts", "line": 1222, "character": 15 } ] }, { "id": 1427, "name": "getPageTitle", "kind": 2048, "kindString": "Method", "flags": { "isExported": true, "isExternal": true }, "signatures": [ { "id": 1428, "name": "getPageTitle", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Gets the title of the top-level browsing context of the current window\nor tab." }, "type": { "type": "reference", "id": 1216, "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "unknown", "name": "P" }, { "type": "unknown", "name": "StringResult" } ], "name": "Command" } } ], "sources": [ { "fileName": "src/Command.ts", "line": 1230, "character": 14 } ] }, { "id": 1572, "name": "getPosition", "kind": 2048, "kindString": "Method", "flags": { "isExported": true, "isExternal": true }, "signatures": [ { "id": 1573, "name": "getPosition", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Gets the position of the element relative to the top-left corner of the\ndocument, taking into account scrolling and CSS transformations (if they\nare supported)." }, "type": { "type": "reference", "id": 1216, "typeArguments": [ { "type": "reflection", "declaration": { "id": 1574, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 1575, "name": "x", "kind": 32, "kindString": "Variable", "flags": { "isExported": true, "isExternal": true }, "sources": [ { "fileName": "src/Command.ts", "line": 1796, "character": 38 } ], "type": { "type": "intrinsic", "name": "number" } }, { "id": 1576, "name": "y", "kind": 32, "kindString": "Variable", "flags": { "isExported": true, "isExternal": true }, "sources": [ { "fileName": "src/Command.ts", "line": 1796, "character": 49 } ], "type": { "type": "intrinsic", "name": "number" } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 1575, 1576 ] } ] } }, { "type": "unknown", "name": "P" }, { "type": "unknown", "name": "StringResult" } ], "name": "Command" } } ], "sources": [ { "fileName": "src/Command.ts", "line": 1795, "character": 13 } ] }, { "id": 1563, "name": "getProperty", "kind": 2048, "kindString": "Method", "flags": { "isExported": true, "isExternal": true }, "signatures": [ { "id": 1564, "name": "getProperty", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Gets a property of the element.", "text": "See [[Element.Element.getAttribute]] to retrieve an element attribute.\n", "returns": "The value of the property.\n" }, "typeParameter": [ { "id": 1565, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": { "isExported": true } } ], "parameters": [ { "id": 1566, "name": "name", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The name of the property." }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "id": 1216, "typeArguments": [ { "type": "unknown", "name": "T" }, { "type": "unknown", "name": "P" }, { "type": "unknown", "name": "StringResult" } ], "name": "Command" } } ], "sources": [ { "fileName": "src/Command.ts", "line": 1763, "character": 13 } ] }, { "id": 1577, "name": "getSize", "kind": 2048, "kindString": "Method", "flags": { "isExported": true, "isExternal": true }, "signatures": [ { "id": 1578, "name": "getSize", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Gets the size of the element, taking into account CSS transformations\n(if they are supported)." }, "type": { "type": "reference", "id": 1216, "typeArguments": [ { "type": "reflection", "declaration": { "id": 1579, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 1581, "name": "height", "kind": 32, "kindString": "Variable", "flags": { "isExported": true, "isExternal": true }, "sources": [ { "fileName": "src/Command.ts", "line": 1804, "character": 58 } ], "type": { "type": "intrinsic", "name": "number" } }, { "id": 1580, "name": "width", "kind": 32, "kindString": "Variable", "flags": { "isExported": true, "isExternal": true }, "sources": [ { "fileName": "src/Command.ts", "line": 1804, "character": 42 } ], "type": { "type": "intrinsic", "name": "number" } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 1581, 1580 ] } ] } }, { "type": "unknown", "name": "P" }, { "type": "unknown", "name": "StringResult" } ], "name": "Command" } } ], "sources": [ { "fileName": "src/Command.ts", "line": 1803, "character": 9 } ] }, { "id": 1556, "name": "getSpecAttribute", "kind": 2048, "kindString": "Method", "flags": { "isExported": true, "isExternal": true }, "signatures": [ { "id": 1557, "name": "getSpecAttribute", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Gets a property or attribute of the element according to the WebDriver\nspecification algorithm. Use of this method is not recommended; instead,\nuse [[Command.Command.getAttribute]] to retrieve DOM attributes and\n[[Command.Command.getProperty]] to retrieve DOM properties.", "text": "This method uses the following algorithm on the server to determine what\nvalue to return:\n\n1. If `name` is 'style', returns the `style.cssText` property of the\n element.\n2. If the attribute exists and is a boolean attribute, returns 'true' if\n the attribute is true, or null otherwise.\n3. If the element is an `