[ { "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Launches a browser with a tab. The browser will be closed when the parent node.js process is closed.", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 101, "offset": 100 }, "indent": [] } }, { "type": "html", "value": "
", "position": { "start": { "line": 1, "column": 101, "offset": 100 }, "end": { "line": 1, "column": 105, "offset": 104 }, "indent": [] } }, { "type": "text", "value": "\nNote : ", "position": { "start": { "line": 1, "column": 105, "offset": 104 }, "end": { "line": 2, "column": 8, "offset": 112 }, "indent": [ 1 ] } }, { "type": "inlineCode", "value": "openBrowser", "position": { "start": { "line": 2, "column": 8, "offset": 112 }, "end": { "line": 2, "column": 21, "offset": 125 }, "indent": [] } }, { "type": "text", "value": " launches the browser in headless mode by default, but when ", "position": { "start": { "line": 2, "column": 21, "offset": 125 }, "end": { "line": 2, "column": 81, "offset": 185 }, "indent": [] } }, { "type": "inlineCode", "value": "openBrowser", "position": { "start": { "line": 2, "column": 81, "offset": 185 }, "end": { "line": 2, "column": 94, "offset": 198 }, "indent": [] } }, { "type": "text", "value": " is called from ", "position": { "start": { "line": 2, "column": 94, "offset": 198 }, "end": { "line": 2, "column": 110, "offset": 214 }, "indent": [] } }, { "type": "link", "url": "repl", "title": null, "jsdoc": true, "children": [ { "type": "text", "value": "repl" } ], "position": { "start": { "line": 2, "column": 110, "offset": 214 }, "end": { "line": 2, "column": 122, "offset": 226 }, "indent": [] } }, { "type": "text", "value": " it launches the browser in headful mode.", "position": { "start": { "line": 2, "column": 122, "offset": 226 }, "end": { "line": 2, "column": 163, "offset": 267 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 2, "column": 163, "offset": 267 }, "indent": [ 1 ] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 2, "column": 163, "offset": 267 } } }, "tags": [ { "title": "example", "description": "await openBrowser({headless: false})\nawait openBrowser()\nawait openBrowser({args:['--window-size=1440,900']})\nawait openBrowser({args: [\n '--disable-gpu',\n '--disable-dev-shm-usage',\n '--disable-setuid-sandbox',\n '--no-first-run',\n '--no-sandbox',\n '--no-zygote']}) # These are recommended args that has to be passed when running in docker", "lineNumber": 3 }, { "title": "param", "description": "eg. {headless: true|false, args:['--window-size=1440,900']}", "lineNumber": 15, "type": { "type": "OptionalType", "expression": { "type": "NameExpression", "name": "Object" } }, "name": "options", "default": "{headless:true}" }, { "title": "param", "description": "Option to open browser in headless/headful mode.", "lineNumber": 16, "type": { "type": "OptionalType", "expression": { "type": "NameExpression", "name": "boolean" } }, "name": "options.headless", "default": "true" }, { "title": "param", "description": "Args to open chromium. Refer https://peter.sh/experiments/chromium-command-line-switches/ for values.", "lineNumber": 17, "type": { "type": "OptionalType", "expression": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "NameExpression", "name": "string" } ] } }, "name": "options.args", "default": "[]" }, { "title": "param", "description": "Remote host to connect to.", "lineNumber": 18, "type": { "type": "OptionalType", "expression": { "type": "NameExpression", "name": "string" } }, "name": "options.host", "default": "'127.0.0.1'" }, { "title": "param", "description": "Remote debugging port, if not given connects to any open port.", "lineNumber": 19, "type": { "type": "OptionalType", "expression": { "type": "NameExpression", "name": "number" } }, "name": "options.port", "default": "0" }, { "title": "param", "description": "Option to ignore certificate errors.", "lineNumber": 20, "type": { "type": "OptionalType", "expression": { "type": "NameExpression", "name": "boolean" } }, "name": "options.ignoreCertificateErrors", "default": "false" }, { "title": "param", "description": "Option to run each command after a delay. Useful to observe what is happening in the browser.", "lineNumber": 21, "type": { "type": "OptionalType", "expression": { "type": "NameExpression", "name": "boolean" } }, "name": "options.observe", "default": "false" }, { "title": "param", "description": "Option to modify delay time for observe mode. Accepts value in milliseconds.", "lineNumber": 22, "type": { "type": "OptionalType", "expression": { "type": "NameExpression", "name": "number" } }, "name": "options.observeTime", "default": "3000" }, { "title": "param", "description": "Option to dump IO from browser.", "lineNumber": 23, "type": { "type": "OptionalType", "expression": { "type": "NameExpression", "name": "boolean" } }, "name": "options.dumpio", "default": "false" }, { "title": "returns", "description": null, "lineNumber": 25, "type": { "type": "NameExpression", "name": "Promise" } } ], "loc": { "start": { "line": 206, "column": 0 }, "end": { "line": 232, "column": 3 } }, "context": { "loc": { "start": { "line": 233, "column": 0 }, "end": { "line": 307, "column": 2 } }, "file": "/Users/fallenmax/code/github/taiko/lib/taiko.js" }, "augments": [], "examples": [ { "description": "await openBrowser({headless: false})\nawait openBrowser()\nawait openBrowser({args:['--window-size=1440,900']})\nawait openBrowser({args: [\n '--disable-gpu',\n '--disable-dev-shm-usage',\n '--disable-setuid-sandbox',\n '--no-first-run',\n '--no-sandbox',\n '--no-zygote']}) # These are recommended args that has to be passed when running in docker" } ], "implements": [], "params": [ { "title": "param", "name": "options", "lineNumber": 15, "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "eg. {headless: true|false, args:", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 33, "offset": 32 }, "indent": [] } }, { "type": "linkReference", "identifier": "'--window-size=1440,900'", "referenceType": "shortcut", "children": [ { "type": "text", "value": "'--window-size=1440,900'", "position": { "start": { "line": 1, "column": 34, "offset": 33 }, "end": { "line": 1, "column": 58, "offset": 57 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 33, "offset": 32 }, "end": { "line": 1, "column": 59, "offset": 58 }, "indent": [] } }, { "type": "text", "value": "}", "position": { "start": { "line": 1, "column": 59, "offset": 58 }, "end": { "line": 1, "column": 60, "offset": 59 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 60, "offset": 59 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 60, "offset": 59 } } }, "type": { "type": "NameExpression", "name": "Object" }, "default": "{headless:true}", "properties": [ { "title": "param", "name": "options.headless", "lineNumber": 16, "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Option to open browser in headless/headful mode.", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 49, "offset": 48 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 49, "offset": 48 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 49, "offset": 48 } } }, "type": { "type": "NameExpression", "name": "boolean" }, "default": "true" }, { "title": "param", "name": "options.args", "lineNumber": 17, "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Args to open chromium. Refer ", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 30, "offset": 29 }, "indent": [] } }, { "type": "link", "title": null, "url": "https://peter.sh/experiments/chromium-command-line-switches/", "children": [ { "type": "text", "value": "https://peter.sh/experiments/chromium-command-line-switches/", "position": { "start": { "line": 1, "column": 30, "offset": 29 }, "end": { "line": 1, "column": 90, "offset": 89 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 30, "offset": 29 }, "end": { "line": 1, "column": 90, "offset": 89 }, "indent": [] } }, { "type": "text", "value": " for values.", "position": { "start": { "line": 1, "column": 90, "offset": 89 }, "end": { "line": 1, "column": 102, "offset": 101 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 102, "offset": 101 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 102, "offset": 101 } } }, "type": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "NameExpression", "name": "string" } ] }, "default": "[]" }, { "title": "param", "name": "options.host", "lineNumber": 18, "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Remote host to connect to.", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 27, "offset": 26 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 27, "offset": 26 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 27, "offset": 26 } } }, "type": { "type": "NameExpression", "name": "string" }, "default": "'127.0.0.1'" }, { "title": "param", "name": "options.port", "lineNumber": 19, "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Remote debugging port, if not given connects to any open port.", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 63, "offset": 62 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 63, "offset": 62 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 63, "offset": 62 } } }, "type": { "type": "NameExpression", "name": "number" }, "default": "0" }, { "title": "param", "name": "options.ignoreCertificateErrors", "lineNumber": 20, "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Option to ignore certificate errors.", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 37, "offset": 36 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 37, "offset": 36 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 37, "offset": 36 } } }, "type": { "type": "NameExpression", "name": "boolean" }, "default": "false" }, { "title": "param", "name": "options.observe", "lineNumber": 21, "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Option to run each command after a delay. Useful to observe what is happening in the browser.", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 94, "offset": 93 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 94, "offset": 93 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 94, "offset": 93 } } }, "type": { "type": "NameExpression", "name": "boolean" }, "default": "false" }, { "title": "param", "name": "options.observeTime", "lineNumber": 22, "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Option to modify delay time for observe mode. Accepts value in milliseconds.", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 77, "offset": 76 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 77, "offset": 76 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 77, "offset": 76 } } }, "type": { "type": "NameExpression", "name": "number" }, "default": "3000" }, { "title": "param", "name": "options.dumpio", "lineNumber": 23, "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Option to dump IO from browser.", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 32, "offset": 31 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 32, "offset": 31 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 32, "offset": 31 } } }, "type": { "type": "NameExpression", "name": "boolean" }, "default": "false" } ] } ], "properties": [], "returns": [ { "description": { "type": "root", "children": [], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 1, "offset": 0 } } }, "title": "returns", "type": { "type": "NameExpression", "name": "Promise" } } ], "sees": [], "throws": [], "todos": [], "yields": [], "name": "openBrowser", "kind": "function", "async": true, "memberof": "taiko", "scope": "static", "members": { "global": [], "inner": [], "instance": [], "events": [], "static": [] }, "path": [ { "name": "openBrowser", "kind": "function", "scope": "static" } ], "namespace": ".openBrowser" }, { "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Closes the browser and along with all of its tabs.", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 51, "offset": 50 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 51, "offset": 50 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 51, "offset": 50 } } }, "tags": [ { "title": "example", "description": "await closeBrowser()", "lineNumber": 3 }, { "title": "returns", "description": null, "lineNumber": 6, "type": { "type": "NameExpression", "name": "Promise" } } ], "loc": { "start": { "line": 308, "column": 0 }, "end": { "line": 315, "column": 3 } }, "context": { "loc": { "start": { "line": 316, "column": 0 }, "end": { "line": 320, "column": 2 } }, "file": "/Users/fallenmax/code/github/taiko/lib/taiko.js" }, "augments": [], "examples": [ { "description": "await closeBrowser()" } ], "implements": [], "params": [], "properties": [], "returns": [ { "description": { "type": "root", "children": [], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 1, "offset": 0 } } }, "title": "returns", "type": { "type": "NameExpression", "name": "Promise" } } ], "sees": [], "throws": [], "todos": [], "yields": [], "name": "closeBrowser", "kind": "function", "async": true, "memberof": "taiko", "scope": "static", "members": { "global": [], "inner": [], "instance": [], "events": [], "static": [] }, "path": [ { "name": "closeBrowser", "kind": "function", "scope": "static" } ], "namespace": ".closeBrowser" }, { "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Gives CRI client object (a wrapper around Chrome DevTools Protocol). Refer ", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 76, "offset": 75 }, "indent": [] } }, { "type": "link", "title": null, "url": "https://github.com/cyrus-and/chrome-remote-interface", "children": [ { "type": "text", "value": "https://github.com/cyrus-and/chrome-remote-interface", "position": { "start": { "line": 1, "column": 76, "offset": 75 }, "end": { "line": 1, "column": 128, "offset": 127 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 76, "offset": 75 }, "end": { "line": 1, "column": 128, "offset": 127 }, "indent": [] } }, { "type": "text", "value": "\nThis is useful while writing plugins or if use some API of ", "position": { "start": { "line": 1, "column": 128, "offset": 127 }, "end": { "line": 2, "column": 60, "offset": 187 }, "indent": [ 1 ] } }, { "type": "link", "title": null, "url": "https://chromedevtools.github.io/devtools-protocol/", "children": [ { "type": "text", "value": "Chrome DevTools Protocol", "position": { "start": { "line": 2, "column": 61, "offset": 188 }, "end": { "line": 2, "column": 85, "offset": 212 }, "indent": [] } } ], "position": { "start": { "line": 2, "column": 60, "offset": 187 }, "end": { "line": 2, "column": 139, "offset": 266 }, "indent": [] } }, { "type": "text", "value": ".", "position": { "start": { "line": 2, "column": 139, "offset": 266 }, "end": { "line": 2, "column": 140, "offset": 267 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 2, "column": 140, "offset": 267 }, "indent": [ 1 ] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 2, "column": 140, "offset": 267 } } }, "tags": [ { "title": "returns", "description": null, "lineNumber": 4, "type": { "type": "NameExpression", "name": "Object" } } ], "loc": { "start": { "line": 396, "column": 0 }, "end": { "line": 401, "column": 3 } }, "context": { "loc": { "start": { "line": 402, "column": 0 }, "end": { "line": 402, "column": 42 } }, "file": "/Users/fallenmax/code/github/taiko/lib/taiko.js" }, "augments": [], "examples": [], "implements": [], "params": [], "properties": [], "returns": [ { "description": { "type": "root", "children": [], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 1, "offset": 0 } } }, "title": "returns", "type": { "type": "NameExpression", "name": "Object" } } ], "sees": [], "throws": [], "todos": [], "yields": [], "name": "client", "kind": "function", "memberof": "taiko", "scope": "static", "members": { "global": [], "inner": [], "instance": [], "events": [], "static": [] }, "path": [ { "name": "client", "kind": "function", "scope": "static" } ], "namespace": ".client" }, { "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Allows switching between tabs using URL or page title or Open Window.", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 70, "offset": 69 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 70, "offset": 69 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 70, "offset": 69 } } }, "tags": [ { "title": "example", "description": "# switch using URL\nawait switchTo('https://taiko.dev')\n# switch using Title\nawait switchTo('Taiko')\n# switch using regex URL\nawait switchTo(/http(s?):\\/\\/(www?).google.(com|co.in|co.uk)/)\n# switch using regex Title\nawait switchTo(/Go*gle/)", "lineNumber": 3 }, { "title": "param", "description": "URL/Page title of the tab to switch.", "lineNumber": 13, "type": { "type": "NameExpression", "name": "string" }, "name": "arg" }, { "title": "returns", "description": null, "lineNumber": 15, "type": { "type": "NameExpression", "name": "Promise" } } ], "loc": { "start": { "line": 403, "column": 0 }, "end": { "line": 419, "column": 3 } }, "context": { "loc": { "start": { "line": 420, "column": 0 }, "end": { "line": 447, "column": 2 } }, "file": "/Users/fallenmax/code/github/taiko/lib/taiko.js" }, "augments": [], "examples": [ { "description": "# switch using URL\nawait switchTo('https://taiko.dev')\n# switch using Title\nawait switchTo('Taiko')\n# switch using regex URL\nawait switchTo(/http(s?):\\/\\/(www?).google.(com|co.in|co.uk)/)\n# switch using regex Title\nawait switchTo(/Go*gle/)" } ], "implements": [], "params": [ { "title": "param", "name": "arg", "lineNumber": 13, "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "URL/Page title of the tab to switch.", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 37, "offset": 36 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 37, "offset": 36 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 37, "offset": 36 } } }, "type": { "type": "NameExpression", "name": "string" } } ], "properties": [], "returns": [ { "description": { "type": "root", "children": [], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 1, "offset": 0 } } }, "title": "returns", "type": { "type": "NameExpression", "name": "Promise" } } ], "sees": [], "throws": [], "todos": [], "yields": [], "name": "switchTo", "kind": "function", "async": true, "memberof": "taiko", "scope": "static", "members": { "global": [], "inner": [], "instance": [], "events": [], "static": [] }, "path": [ { "name": "switchTo", "kind": "function", "scope": "static" } ], "namespace": ".switchTo" }, { "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Add interceptor for the network call. Helps in overriding request or to mock response of a network call.", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 105, "offset": 104 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 105, "offset": 104 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 105, "offset": 104 } } }, "tags": [ { "title": "example", "description": "# case 1: block URL :\nawait intercept(url)\n# case 2: mockResponse :\nawait intercept(url, {mockObject})\n# case 3: override request :\nawait intercept(url, (request) => {request.continue({overrideObject})})\n# case 4: redirect always :\nawait intercept(url, redirectUrl)\n# case 5: mockResponse based on request :\nawait intercept(url, (request) => { request.respond({mockResponseObject}) })\n# case 6: block URL twice:\nawait intercept(url, undefined, 2)\n# case 7: mockResponse only 3 times :\nawait intercept(url, {mockObject}, 3)", "lineNumber": 3 }, { "title": "param", "description": "request URL to intercept", "lineNumber": 19, "type": { "type": "NameExpression", "name": "string" }, "name": "requestUrl" }, { "title": "param", "description": "action to be done after interception. For more examples refer to https://github.com/getgauge/taiko/issues/98#issuecomment-42024186", "lineNumber": 20, "type": { "type": "UnionType", "elements": [ { "type": "NameExpression", "name": "function" }, { "type": "NameExpression", "name": "Object" } ] }, "name": "option" }, { "title": "param", "description": "number of times the request has to be intercepted . Optional parameter", "lineNumber": 21, "type": { "type": "NameExpression", "name": "number" }, "name": "count" }, { "title": "returns", "description": null, "lineNumber": 23, "type": { "type": "NameExpression", "name": "Promise" } } ], "loc": { "start": { "line": 448, "column": 0 }, "end": { "line": 472, "column": 3 } }, "context": { "loc": { "start": { "line": 473, "column": 0 }, "end": { "line": 480, "column": 2 } }, "file": "/Users/fallenmax/code/github/taiko/lib/taiko.js" }, "augments": [], "examples": [ { "description": "# case 1: block URL :\nawait intercept(url)\n# case 2: mockResponse :\nawait intercept(url, {mockObject})\n# case 3: override request :\nawait intercept(url, (request) => {request.continue({overrideObject})})\n# case 4: redirect always :\nawait intercept(url, redirectUrl)\n# case 5: mockResponse based on request :\nawait intercept(url, (request) => { request.respond({mockResponseObject}) })\n# case 6: block URL twice:\nawait intercept(url, undefined, 2)\n# case 7: mockResponse only 3 times :\nawait intercept(url, {mockObject}, 3)" } ], "implements": [], "params": [ { "title": "param", "name": "requestUrl", "lineNumber": 19, "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "request URL to intercept", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 25, "offset": 24 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 25, "offset": 24 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 25, "offset": 24 } } }, "type": { "type": "NameExpression", "name": "string" } }, { "title": "param", "name": "option", "lineNumber": 20, "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "action to be done after interception. For more examples refer to ", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 66, "offset": 65 }, "indent": [] } }, { "type": "link", "title": null, "url": "https://github.com/getgauge/taiko/issues/98#issuecomment-42024186", "children": [ { "type": "text", "value": "https://github.com/getgauge/taiko/issues/98#issuecomment-42024186", "position": { "start": { "line": 1, "column": 66, "offset": 65 }, "end": { "line": 1, "column": 131, "offset": 130 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 66, "offset": 65 }, "end": { "line": 1, "column": 131, "offset": 130 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 131, "offset": 130 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 131, "offset": 130 } } }, "type": { "type": "UnionType", "elements": [ { "type": "NameExpression", "name": "function" }, { "type": "NameExpression", "name": "Object" } ] } }, { "title": "param", "name": "count", "lineNumber": 21, "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "number of times the request has to be intercepted . Optional parameter", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 71, "offset": 70 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 71, "offset": 70 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 71, "offset": 70 } } }, "type": { "type": "NameExpression", "name": "number" } } ], "properties": [], "returns": [ { "description": { "type": "root", "children": [], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 1, "offset": 0 } } }, "title": "returns", "type": { "type": "NameExpression", "name": "Promise" } } ], "sees": [], "throws": [], "todos": [], "yields": [], "name": "intercept", "kind": "function", "async": true, "memberof": "taiko", "scope": "static", "members": { "global": [], "inner": [], "instance": [], "events": [], "static": [] }, "path": [ { "name": "intercept", "kind": "function", "scope": "static" } ], "namespace": ".intercept" }, { "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Activates emulation of network conditions.", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 43, "offset": 42 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 43, "offset": 42 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 43, "offset": 42 } } }, "tags": [ { "title": "example", "description": "await emulateNetwork(\"Offline\")\nawait emulateNetwork(\"Good2G\")", "lineNumber": 3 }, { "title": "param", "description": "'GPRS','Regular2G','Good2G','Good3G','Regular3G','Regular4G','DSL','WiFi, Offline'", "lineNumber": 7, "type": { "type": "NameExpression", "name": "string" }, "name": "networkType" }, { "title": "returns", "description": null, "lineNumber": 9, "type": { "type": "NameExpression", "name": "Promise" } } ], "loc": { "start": { "line": 481, "column": 0 }, "end": { "line": 491, "column": 3 } }, "context": { "loc": { "start": { "line": 492, "column": 0 }, "end": { "line": 496, "column": 2 } }, "file": "/Users/fallenmax/code/github/taiko/lib/taiko.js" }, "augments": [], "examples": [ { "description": "await emulateNetwork(\"Offline\")\nawait emulateNetwork(\"Good2G\")" } ], "implements": [], "params": [ { "title": "param", "name": "networkType", "lineNumber": 7, "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "'GPRS','Regular2G','Good2G','Good3G','Regular3G','Regular4G','DSL','WiFi, Offline'", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 83, "offset": 82 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 83, "offset": 82 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 83, "offset": 82 } } }, "type": { "type": "NameExpression", "name": "string" } } ], "properties": [], "returns": [ { "description": { "type": "root", "children": [], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 1, "offset": 0 } } }, "title": "returns", "type": { "type": "NameExpression", "name": "Promise" } } ], "sees": [], "throws": [], "todos": [], "yields": [], "name": "emulateNetwork", "kind": "function", "async": true, "memberof": "taiko", "scope": "static", "members": { "global": [], "inner": [], "instance": [], "events": [], "static": [] }, "path": [ { "name": "emulateNetwork", "kind": "function", "scope": "static" } ], "namespace": ".emulateNetwork" }, { "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Overrides the values of device screen dimensions according to a predefined list of devices. To provide custom device dimensions, use setViewPort API.", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 150, "offset": 149 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 150, "offset": 149 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 150, "offset": 149 } } }, "tags": [ { "title": "example", "description": "await emulateDevice('iPhone 6')", "lineNumber": 3 }, { "title": "param", "description": "See [device model](https://github.com/getgauge/taiko/blob/master/lib/data/devices.js) for a list of all device models.", "lineNumber": 6, "type": { "type": "NameExpression", "name": "string" }, "name": "deviceModel" }, { "title": "returns", "description": null, "lineNumber": 8, "type": { "type": "NameExpression", "name": "Promise" } } ], "loc": { "start": { "line": 497, "column": 0 }, "end": { "line": 506, "column": 3 } }, "context": { "loc": { "start": { "line": 507, "column": 0 }, "end": { "line": 507, "column": 45 } }, "file": "/Users/fallenmax/code/github/taiko/lib/taiko.js" }, "augments": [], "examples": [ { "description": "await emulateDevice('iPhone 6')" } ], "implements": [], "params": [ { "title": "param", "name": "deviceModel", "lineNumber": 6, "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "See ", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 5, "offset": 4 }, "indent": [] } }, { "type": "link", "title": null, "url": "https://github.com/getgauge/taiko/blob/master/lib/data/devices.js", "children": [ { "type": "text", "value": "device model", "position": { "start": { "line": 1, "column": 6, "offset": 5 }, "end": { "line": 1, "column": 18, "offset": 17 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 5, "offset": 4 }, "end": { "line": 1, "column": 86, "offset": 85 }, "indent": [] } }, { "type": "text", "value": " for a list of all device models.", "position": { "start": { "line": 1, "column": 86, "offset": 85 }, "end": { "line": 1, "column": 119, "offset": 118 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 119, "offset": 118 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 119, "offset": 118 } } }, "type": { "type": "NameExpression", "name": "string" } } ], "properties": [], "returns": [ { "description": { "type": "root", "children": [], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 1, "offset": 0 } } }, "title": "returns", "type": { "type": "NameExpression", "name": "Promise" } } ], "sees": [], "throws": [], "todos": [], "yields": [], "name": "emulateDevice", "memberof": "taiko", "scope": "static", "members": { "global": [], "inner": [], "instance": [], "events": [], "static": [] }, "path": [ { "name": "emulateDevice", "scope": "static" } ], "namespace": ".emulateDevice" }, { "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Overrides the values of device screen dimensions", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 49, "offset": 48 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 49, "offset": 48 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 49, "offset": 48 } } }, "tags": [ { "title": "example", "description": "await setViewPort({width:600, height:800})", "lineNumber": 3 }, { "title": "param", "description": "See [chrome devtools setDeviceMetricsOverride](https://chromedevtools.github.io/devtools-protocol/tot/Emulation#method-setDeviceMetricsOverride) for a list of options", "lineNumber": 6, "type": { "type": "NameExpression", "name": "Object" }, "name": "options" }, { "title": "returns", "description": null, "lineNumber": 8, "type": { "type": "NameExpression", "name": "Promise" } } ], "loc": { "start": { "line": 524, "column": 0 }, "end": { "line": 533, "column": 3 } }, "context": { "loc": { "start": { "line": 534, "column": 0 }, "end": { "line": 538, "column": 2 } }, "file": "/Users/fallenmax/code/github/taiko/lib/taiko.js" }, "augments": [], "examples": [ { "description": "await setViewPort({width:600, height:800})" } ], "implements": [], "params": [ { "title": "param", "name": "options", "lineNumber": 6, "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "See ", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 5, "offset": 4 }, "indent": [] } }, { "type": "link", "title": null, "url": "https://chromedevtools.github.io/devtools-protocol/tot/Emulation#method-setDeviceMetricsOverride", "children": [ { "type": "text", "value": "chrome devtools setDeviceMetricsOverride", "position": { "start": { "line": 1, "column": 6, "offset": 5 }, "end": { "line": 1, "column": 46, "offset": 45 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 5, "offset": 4 }, "end": { "line": 1, "column": 145, "offset": 144 }, "indent": [] } }, { "type": "text", "value": " for a list of options", "position": { "start": { "line": 1, "column": 145, "offset": 144 }, "end": { "line": 1, "column": 167, "offset": 166 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 167, "offset": 166 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 167, "offset": 166 } } }, "type": { "type": "NameExpression", "name": "Object" } } ], "properties": [], "returns": [ { "description": { "type": "root", "children": [], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 1, "offset": 0 } } }, "title": "returns", "type": { "type": "NameExpression", "name": "Promise" } } ], "sees": [], "throws": [], "todos": [], "yields": [], "name": "setViewPort", "kind": "function", "async": true, "memberof": "taiko", "scope": "static", "members": { "global": [], "inner": [], "instance": [], "events": [], "static": [] }, "path": [ { "name": "setViewPort", "kind": "function", "scope": "static" } ], "namespace": ".setViewPort" }, { "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Changes the timezone of the page. See ", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 39, "offset": 38 }, "indent": [] } }, { "type": "link", "title": null, "url": "https://cs.chromium.org/chromium/src/third_party/icu/source/data/misc/metaZones.txt?rcl=faee8bc70570192d82d2978a71e2a615788597d1", "children": [ { "type": "inlineCode", "value": "metaZones.txt", "position": { "start": { "line": 1, "column": 40, "offset": 39 }, "end": { "line": 1, "column": 55, "offset": 54 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 39, "offset": 38 }, "end": { "line": 1, "column": 186, "offset": 185 }, "indent": [] } }, { "type": "text", "value": "\nfor a list of supported timezone IDs.", "position": { "start": { "line": 1, "column": 186, "offset": 185 }, "end": { "line": 2, "column": 38, "offset": 223 }, "indent": [ 1 ] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 2, "column": 38, "offset": 223 }, "indent": [ 1 ] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 2, "column": 38, "offset": 223 } } }, "tags": [ { "title": "example", "description": "await emulateTimezone('America/Jamaica')", "lineNumber": 3 } ], "loc": { "start": { "line": 539, "column": 0 }, "end": { "line": 544, "column": 3 } }, "context": { "loc": { "start": { "line": 545, "column": 0 }, "end": { "line": 548, "column": 2 } }, "file": "/Users/fallenmax/code/github/taiko/lib/taiko.js" }, "augments": [], "examples": [ { "description": "await emulateTimezone('America/Jamaica')" } ], "implements": [], "params": [ { "title": "param", "name": "timezoneId", "lineNumber": 545 } ], "properties": [], "returns": [], "sees": [], "throws": [], "todos": [], "yields": [], "name": "emulateTimezone", "kind": "function", "async": true, "memberof": "taiko", "scope": "static", "members": { "global": [], "inner": [], "instance": [], "events": [], "static": [] }, "path": [ { "name": "emulateTimezone", "kind": "function", "scope": "static" } ], "namespace": ".emulateTimezone" }, { "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Launches a new tab. If url is provided, the new tab is opened with the url loaded.", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 83, "offset": 82 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 83, "offset": 82 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 83, "offset": 82 } } }, "tags": [ { "title": "example", "description": "await openTab('https://taiko.dev')\nawait openTab() # opens a blank tab.", "lineNumber": 2 }, { "title": "param", "description": "Url of page to open in newly created tab.", "lineNumber": 6, "type": { "type": "OptionalType", "expression": { "type": "NameExpression", "name": "string" } }, "name": "targetUrl", "default": "undefined" }, { "title": "param", "description": null, "lineNumber": 7, "type": { "type": "NameExpression", "name": "Object" }, "name": "options" }, { "title": "param", "description": "Wait for navigation after the reload. Default navigation timeout is 5000 milliseconds, to override pass `{ navigationTimeout: 10000 }` in `options` parameter.", "lineNumber": 8, "type": { "type": "OptionalType", "expression": { "type": "NameExpression", "name": "boolean" } }, "name": "options.waitForNavigation", "default": "true" }, { "title": "param", "description": "Navigation timeout value in milliseconds for navigation after click. Accepts value in milliseconds.", "lineNumber": 9, "type": { "type": "OptionalType", "expression": { "type": "NameExpression", "name": "number" } }, "name": "options.navigationTimeout", "default": "5000" }, { "title": "param", "description": "time to wait to check for occurrence of page load events. Accepts value in milliseconds.", "lineNumber": 10, "type": { "type": "OptionalType", "expression": { "type": "NameExpression", "name": "number" } }, "name": "options.waitForStart", "default": "100" }, { "title": "param", "description": "Page load events to implicitly wait for. Events available to wait for ['DOMContentLoaded', 'loadEventFired', 'networkAlmostIdle', 'networkIdle', 'firstPaint', 'firstContentfulPaint', 'firstMeaningfulPaint']]", "lineNumber": 11, "type": { "type": "OptionalType", "expression": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "NameExpression", "name": "string" } ] } }, "name": "options.waitForEvents", "default": "['firstMeaningfulPaint']" }, { "title": "returns", "description": null, "lineNumber": 13, "type": { "type": "NameExpression", "name": "Promise" } } ], "loc": { "start": { "line": 549, "column": 0 }, "end": { "line": 563, "column": 3 } }, "context": { "loc": { "start": { "line": 564, "column": 0 }, "end": { "line": 589, "column": 2 } }, "file": "/Users/fallenmax/code/github/taiko/lib/taiko.js" }, "augments": [], "examples": [ { "description": "await openTab('https://taiko.dev')\nawait openTab() # opens a blank tab." } ], "implements": [], "params": [ { "title": "param", "name": "targetUrl", "lineNumber": 6, "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Url of page to open in newly created tab.", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 42, "offset": 41 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 42, "offset": 41 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 42, "offset": 41 } } }, "type": { "type": "NameExpression", "name": "string" }, "default": "undefined" }, { "title": "param", "name": "options", "lineNumber": 7, "type": { "type": "NameExpression", "name": "Object" }, "properties": [ { "title": "param", "name": "options.waitForNavigation", "lineNumber": 8, "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Wait for navigation after the reload. Default navigation timeout is 5000 milliseconds, to override pass ", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 105, "offset": 104 }, "indent": [] } }, { "type": "inlineCode", "value": "{ navigationTimeout: 10000 }", "position": { "start": { "line": 1, "column": 105, "offset": 104 }, "end": { "line": 1, "column": 135, "offset": 134 }, "indent": [] } }, { "type": "text", "value": " in ", "position": { "start": { "line": 1, "column": 135, "offset": 134 }, "end": { "line": 1, "column": 139, "offset": 138 }, "indent": [] } }, { "type": "inlineCode", "value": "options", "position": { "start": { "line": 1, "column": 139, "offset": 138 }, "end": { "line": 1, "column": 148, "offset": 147 }, "indent": [] } }, { "type": "text", "value": " parameter.", "position": { "start": { "line": 1, "column": 148, "offset": 147 }, "end": { "line": 1, "column": 159, "offset": 158 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 159, "offset": 158 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 159, "offset": 158 } } }, "type": { "type": "NameExpression", "name": "boolean" }, "default": "true" }, { "title": "param", "name": "options.navigationTimeout", "lineNumber": 9, "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Navigation timeout value in milliseconds for navigation after click. Accepts value in milliseconds.", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 100, "offset": 99 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 100, "offset": 99 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 100, "offset": 99 } } }, "type": { "type": "NameExpression", "name": "number" }, "default": "5000" }, { "title": "param", "name": "options.waitForStart", "lineNumber": 10, "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "time to wait to check for occurrence of page load events. Accepts value in milliseconds.", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 89, "offset": 88 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 89, "offset": 88 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 89, "offset": 88 } } }, "type": { "type": "NameExpression", "name": "number" }, "default": "100" }, { "title": "param", "name": "options.waitForEvents", "lineNumber": 11, "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Page load events to implicitly wait for. Events available to wait for ", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 71, "offset": 70 }, "indent": [] } }, { "type": "linkReference", "identifier": "'domcontentloaded', 'loadeventfired', 'networkalmostidle', 'networkidle', 'firstpaint', 'firstcontentfulpaint', 'firstmeaningfulpaint'", "referenceType": "shortcut", "children": [ { "type": "text", "value": "'DOMContentLoaded', 'loadEventFired', 'networkAlmostIdle', 'networkIdle', 'firstPaint', 'firstContentfulPaint', 'firstMeaningfulPaint'", "position": { "start": { "line": 1, "column": 72, "offset": 71 }, "end": { "line": 1, "column": 206, "offset": 205 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 71, "offset": 70 }, "end": { "line": 1, "column": 207, "offset": 206 }, "indent": [] } }, { "type": "text", "value": "]", "position": { "start": { "line": 1, "column": 207, "offset": 206 }, "end": { "line": 1, "column": 208, "offset": 207 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 208, "offset": 207 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 208, "offset": 207 } } }, "type": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "NameExpression", "name": "string" } ] }, "default": "['firstMeaningfulPaint']" } ], "default": "{navigationTimeout:defaultConfig.navigationTimeout}" } ], "properties": [], "returns": [ { "description": { "type": "root", "children": [], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 1, "offset": 0 } } }, "title": "returns", "type": { "type": "NameExpression", "name": "Promise" } } ], "sees": [], "throws": [], "todos": [], "yields": [], "name": "openTab", "kind": "function", "async": true, "memberof": "taiko", "scope": "static", "members": { "global": [], "inner": [], "instance": [], "events": [], "static": [] }, "path": [ { "name": "openTab", "kind": "function", "scope": "static" } ], "namespace": ".openTab" }, { "description": "", "tags": [ { "title": "deprecated", "description": "Use openIncognitoWindow\nOpens the specified URL in the browser's window. Adds `http` protocol to the URL if not present.", "lineNumber": 1 }, { "title": "example", "description": "await openWindow('https://google.com', { name: 'windowName' }) - Opens a Incognito window\nawait openWindow('https://google.com', { name: 'windowName', incognito: false }) - Opens normal window", "lineNumber": 3 }, { "title": "param", "description": "URL to navigate page to.", "lineNumber": 6, "type": { "type": "NameExpression", "name": "string" }, "name": "url" }, { "title": "param", "description": null, "lineNumber": 7, "type": { "type": "NameExpression", "name": "Object" }, "name": "options" }, { "title": "param", "description": "Wait for navigation after the goto. Default navigationTimeout is 30 seconds to override pass `{ navigationTimeout: 10000 }` in `options` parameter.", "lineNumber": 8, "type": { "type": "OptionalType", "expression": { "type": "NameExpression", "name": "boolean" } }, "name": "options.waitForNavigation", "default": "true" }, { "title": "param", "description": "Events available to wait for ['DOMContentLoaded', 'loadEventFired', 'networkAlmostIdle', 'networkIdle', 'firstPaint', 'firstContentfulPaint', 'firstMeaningfulPaint']", "lineNumber": 9, "type": { "type": "OptionalType", "expression": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "NameExpression", "name": "string" } ] } }, "name": "options.waitForEvents", "default": "['firstMeaningfulPaint']" }, { "title": "param", "description": "Navigation timeout value in milliseconds for navigation after click.", "lineNumber": 10, "type": { "type": "OptionalType", "expression": { "type": "NameExpression", "name": "number" } }, "name": "options.navigationTimeout", "default": "30000" }, { "title": "param", "description": "Map with extra HTTP headers.", "lineNumber": 11, "type": { "type": "NameExpression", "name": "Object" }, "name": "options.headers" }, { "title": "param", "description": "time to wait for navigation to start. Accepts value in milliseconds.", "lineNumber": 12, "type": { "type": "OptionalType", "expression": { "type": "NameExpression", "name": "number" } }, "name": "options.waitForStart", "default": "100" }, { "title": "returns", "description": null, "lineNumber": 14, "type": { "type": "NameExpression", "name": "Promise" } } ], "loc": { "start": { "line": 590, "column": 0 }, "end": { "line": 605, "column": 3 } }, "context": { "loc": { "start": { "line": 606, "column": 0 }, "end": { "line": 633, "column": 2 } }, "file": "/Users/fallenmax/code/github/taiko/lib/taiko.js" }, "augments": [], "examples": [ { "description": "await openWindow('https://google.com', { name: 'windowName' }) - Opens a Incognito window\nawait openWindow('https://google.com', { name: 'windowName', incognito: false }) - Opens normal window" } ], "implements": [], "params": [ { "title": "param", "name": "url", "lineNumber": 6, "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "URL to navigate page to.", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 25, "offset": 24 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 25, "offset": 24 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 25, "offset": 24 } } }, "type": { "type": "NameExpression", "name": "string" } }, { "title": "param", "name": "options", "lineNumber": 7, "type": { "type": "NameExpression", "name": "Object" }, "properties": [ { "title": "param", "name": "options.waitForNavigation", "lineNumber": 8, "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Wait for navigation after the goto. Default navigationTimeout is 30 seconds to override pass ", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 94, "offset": 93 }, "indent": [] } }, { "type": "inlineCode", "value": "{ navigationTimeout: 10000 }", "position": { "start": { "line": 1, "column": 94, "offset": 93 }, "end": { "line": 1, "column": 124, "offset": 123 }, "indent": [] } }, { "type": "text", "value": " in ", "position": { "start": { "line": 1, "column": 124, "offset": 123 }, "end": { "line": 1, "column": 128, "offset": 127 }, "indent": [] } }, { "type": "inlineCode", "value": "options", "position": { "start": { "line": 1, "column": 128, "offset": 127 }, "end": { "line": 1, "column": 137, "offset": 136 }, "indent": [] } }, { "type": "text", "value": " parameter.", "position": { "start": { "line": 1, "column": 137, "offset": 136 }, "end": { "line": 1, "column": 148, "offset": 147 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 148, "offset": 147 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 148, "offset": 147 } } }, "type": { "type": "NameExpression", "name": "boolean" }, "default": "true" }, { "title": "param", "name": "options.waitForEvents", "lineNumber": 9, "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Events available to wait for ", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 30, "offset": 29 }, "indent": [] } }, { "type": "linkReference", "identifier": "'domcontentloaded', 'loadeventfired', 'networkalmostidle', 'networkidle', 'firstpaint', 'firstcontentfulpaint', 'firstmeaningfulpaint'", "referenceType": "shortcut", "children": [ { "type": "text", "value": "'DOMContentLoaded', 'loadEventFired', 'networkAlmostIdle', 'networkIdle', 'firstPaint', 'firstContentfulPaint', 'firstMeaningfulPaint'", "position": { "start": { "line": 1, "column": 31, "offset": 30 }, "end": { "line": 1, "column": 165, "offset": 164 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 30, "offset": 29 }, "end": { "line": 1, "column": 166, "offset": 165 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 166, "offset": 165 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 166, "offset": 165 } } }, "type": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "NameExpression", "name": "string" } ] }, "default": "['firstMeaningfulPaint']" }, { "title": "param", "name": "options.navigationTimeout", "lineNumber": 10, "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Navigation timeout value in milliseconds for navigation after click.", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 69, "offset": 68 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 69, "offset": 68 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 69, "offset": 68 } } }, "type": { "type": "NameExpression", "name": "number" }, "default": "30000" }, { "title": "param", "name": "options.headers", "lineNumber": 11, "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Map with extra HTTP headers.", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 29, "offset": 28 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 29, "offset": 28 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 29, "offset": 28 } } }, "type": { "type": "NameExpression", "name": "Object" } }, { "title": "param", "name": "options.waitForStart", "lineNumber": 12, "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "time to wait for navigation to start. Accepts value in milliseconds.", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 69, "offset": 68 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 69, "offset": 68 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 69, "offset": 68 } } }, "type": { "type": "NameExpression", "name": "number" }, "default": "100" } ], "default": "{}" } ], "properties": [], "returns": [ { "description": { "type": "root", "children": [], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 1, "offset": 0 } } }, "title": "returns", "type": { "type": "NameExpression", "name": "Promise" } } ], "sees": [], "throws": [], "todos": [], "yields": [], "deprecated": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Use openIncognitoWindow\nOpens the specified URL in the browser's window. Adds ", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 2, "column": 55, "offset": 78 }, "indent": [ 1 ] } }, { "type": "inlineCode", "value": "http", "position": { "start": { "line": 2, "column": 55, "offset": 78 }, "end": { "line": 2, "column": 61, "offset": 84 }, "indent": [] } }, { "type": "text", "value": " protocol to the URL if not present.", "position": { "start": { "line": 2, "column": 61, "offset": 84 }, "end": { "line": 2, "column": 97, "offset": 120 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 2, "column": 97, "offset": 120 }, "indent": [ 1 ] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 2, "column": 97, "offset": 120 } } }, "name": "openWindow", "kind": "function", "async": true, "memberof": "taiko", "scope": "static", "members": { "global": [], "inner": [], "instance": [], "events": [], "static": [] }, "path": [ { "name": "openWindow", "kind": "function", "scope": "static" } ], "namespace": ".openWindow" }, { "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Opens the specified URL in the browser's window. Adds ", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 55, "offset": 54 }, "indent": [] } }, { "type": "inlineCode", "value": "http", "position": { "start": { "line": 1, "column": 55, "offset": 54 }, "end": { "line": 1, "column": 61, "offset": 60 }, "indent": [] } }, { "type": "text", "value": " protocol to the URL if not present.", "position": { "start": { "line": 1, "column": 61, "offset": 60 }, "end": { "line": 1, "column": 97, "offset": 96 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 97, "offset": 96 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 97, "offset": 96 } } }, "tags": [ { "title": "example", "description": "await openIncognitoWindow('https://google.com', { name: 'windowName' }) - Open a incognito window", "lineNumber": 2 }, { "title": "param", "description": "URL to navigate page to.", "lineNumber": 4, "type": { "type": "NameExpression", "name": "string" }, "name": "url" }, { "title": "param", "description": null, "lineNumber": 5, "type": { "type": "NameExpression", "name": "Object" }, "name": "options" }, { "title": "param", "description": "Wait for navigation after the goto. Default navigationTimeout is 30 seconds to override pass `{ navigationTimeout: 10000 }` in `options` parameter.", "lineNumber": 6, "type": { "type": "OptionalType", "expression": { "type": "NameExpression", "name": "boolean" } }, "name": "options.waitForNavigation", "default": "true" }, { "title": "param", "description": "Events available to wait for ['DOMContentLoaded', 'loadEventFired', 'networkAlmostIdle', 'networkIdle', 'firstPaint', 'firstContentfulPaint', 'firstMeaningfulPaint']", "lineNumber": 7, "type": { "type": "OptionalType", "expression": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "NameExpression", "name": "string" } ] } }, "name": "options.waitForEvents", "default": "['firstMeaningfulPaint']" }, { "title": "param", "description": "Navigation timeout value in milliseconds for navigation after click.", "lineNumber": 8, "type": { "type": "OptionalType", "expression": { "type": "NameExpression", "name": "number" } }, "name": "options.navigationTimeout", "default": "30000" }, { "title": "param", "description": "Map with extra HTTP headers.", "lineNumber": 9, "type": { "type": "NameExpression", "name": "Object" }, "name": "options.headers" }, { "title": "param", "description": "time to wait for navigation to start. Accepts value in milliseconds.", "lineNumber": 10, "type": { "type": "OptionalType", "expression": { "type": "NameExpression", "name": "number" } }, "name": "options.waitForStart", "default": "100" }, { "title": "returns", "description": null, "lineNumber": 12, "type": { "type": "NameExpression", "name": "Promise" } } ], "loc": { "start": { "line": 634, "column": 0 }, "end": { "line": 647, "column": 3 } }, "context": { "loc": { "start": { "line": 648, "column": 0 }, "end": { "line": 677, "column": 2 } }, "file": "/Users/fallenmax/code/github/taiko/lib/taiko.js" }, "augments": [], "examples": [ { "description": "await openIncognitoWindow('https://google.com', { name: 'windowName' }) - Open a incognito window" } ], "implements": [], "params": [ { "title": "param", "name": "url", "lineNumber": 4, "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "URL to navigate page to.", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 25, "offset": 24 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 25, "offset": 24 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 25, "offset": 24 } } }, "type": { "type": "NameExpression", "name": "string" } }, { "title": "param", "name": "options", "lineNumber": 5, "type": { "type": "NameExpression", "name": "Object" }, "properties": [ { "title": "param", "name": "options.waitForNavigation", "lineNumber": 6, "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Wait for navigation after the goto. Default navigationTimeout is 30 seconds to override pass ", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 94, "offset": 93 }, "indent": [] } }, { "type": "inlineCode", "value": "{ navigationTimeout: 10000 }", "position": { "start": { "line": 1, "column": 94, "offset": 93 }, "end": { "line": 1, "column": 124, "offset": 123 }, "indent": [] } }, { "type": "text", "value": " in ", "position": { "start": { "line": 1, "column": 124, "offset": 123 }, "end": { "line": 1, "column": 128, "offset": 127 }, "indent": [] } }, { "type": "inlineCode", "value": "options", "position": { "start": { "line": 1, "column": 128, "offset": 127 }, "end": { "line": 1, "column": 137, "offset": 136 }, "indent": [] } }, { "type": "text", "value": " parameter.", "position": { "start": { "line": 1, "column": 137, "offset": 136 }, "end": { "line": 1, "column": 148, "offset": 147 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 148, "offset": 147 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 148, "offset": 147 } } }, "type": { "type": "NameExpression", "name": "boolean" }, "default": "true" }, { "title": "param", "name": "options.waitForEvents", "lineNumber": 7, "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Events available to wait for ", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 30, "offset": 29 }, "indent": [] } }, { "type": "linkReference", "identifier": "'domcontentloaded', 'loadeventfired', 'networkalmostidle', 'networkidle', 'firstpaint', 'firstcontentfulpaint', 'firstmeaningfulpaint'", "referenceType": "shortcut", "children": [ { "type": "text", "value": "'DOMContentLoaded', 'loadEventFired', 'networkAlmostIdle', 'networkIdle', 'firstPaint', 'firstContentfulPaint', 'firstMeaningfulPaint'", "position": { "start": { "line": 1, "column": 31, "offset": 30 }, "end": { "line": 1, "column": 165, "offset": 164 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 30, "offset": 29 }, "end": { "line": 1, "column": 166, "offset": 165 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 166, "offset": 165 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 166, "offset": 165 } } }, "type": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "NameExpression", "name": "string" } ] }, "default": "['firstMeaningfulPaint']" }, { "title": "param", "name": "options.navigationTimeout", "lineNumber": 8, "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Navigation timeout value in milliseconds for navigation after click.", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 69, "offset": 68 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 69, "offset": 68 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 69, "offset": 68 } } }, "type": { "type": "NameExpression", "name": "number" }, "default": "30000" }, { "title": "param", "name": "options.headers", "lineNumber": 9, "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Map with extra HTTP headers.", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 29, "offset": 28 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 29, "offset": 28 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 29, "offset": 28 } } }, "type": { "type": "NameExpression", "name": "Object" } }, { "title": "param", "name": "options.waitForStart", "lineNumber": 10, "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "time to wait for navigation to start. Accepts value in milliseconds.", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 69, "offset": 68 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 69, "offset": 68 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 69, "offset": 68 } } }, "type": { "type": "NameExpression", "name": "number" }, "default": "100" } ], "default": "{}" } ], "properties": [], "returns": [ { "description": { "type": "root", "children": [], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 1, "offset": 0 } } }, "title": "returns", "type": { "type": "NameExpression", "name": "Promise" } } ], "sees": [], "throws": [], "todos": [], "yields": [], "name": "openIncognitoWindow", "kind": "function", "async": true, "memberof": "taiko", "scope": "static", "members": { "global": [], "inner": [], "instance": [], "events": [], "static": [] }, "path": [ { "name": "openIncognitoWindow", "kind": "function", "scope": "static" } ], "namespace": ".openIncognitoWindow" }, { "description": "", "tags": [ { "title": "deprecated", "description": "Use closeIncognitoWindow\nCloses the specified browser window.", "lineNumber": 1 }, { "title": "example", "description": "await closeWindow('windowName') - Closes a window with given arg", "lineNumber": 3 } ], "loc": { "start": { "line": 678, "column": 0 }, "end": { "line": 683, "column": 3 } }, "context": { "loc": { "start": { "line": 684, "column": 0 }, "end": { "line": 689, "column": 2 } }, "file": "/Users/fallenmax/code/github/taiko/lib/taiko.js" }, "augments": [], "examples": [ { "description": "await closeWindow('windowName') - Closes a window with given arg" } ], "implements": [], "params": [ { "title": "param", "name": "arg", "lineNumber": 684 } ], "properties": [], "returns": [], "sees": [], "throws": [], "todos": [], "yields": [], "deprecated": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Use closeIncognitoWindow\nCloses the specified browser window.", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 2, "column": 37, "offset": 61 }, "indent": [ 1 ] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 2, "column": 37, "offset": 61 }, "indent": [ 1 ] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 2, "column": 37, "offset": 61 } } }, "name": "closeWindow", "kind": "function", "async": true, "memberof": "taiko", "scope": "static", "members": { "global": [], "inner": [], "instance": [], "events": [], "static": [] }, "path": [ { "name": "closeWindow", "kind": "function", "scope": "static" } ], "namespace": ".closeWindow" }, { "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Closes the specified browser window.", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 37, "offset": 36 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 37, "offset": 36 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 37, "offset": 36 } } }, "tags": [ { "title": "example", "description": "await closeIncognitoWindow('windowName') - Close incognito window", "lineNumber": 2 }, { "title": "param", "description": "incognito window name", "lineNumber": 4, "type": { "type": "NameExpression", "name": "string" }, "name": "windowName" } ], "loc": { "start": { "line": 690, "column": 0 }, "end": { "line": 695, "column": 3 } }, "context": { "loc": { "start": { "line": 696, "column": 0 }, "end": { "line": 706, "column": 2 } }, "file": "/Users/fallenmax/code/github/taiko/lib/taiko.js" }, "augments": [], "examples": [ { "description": "await closeIncognitoWindow('windowName') - Close incognito window" } ], "implements": [], "params": [ { "title": "param", "name": "arg", "lineNumber": 696 }, { "title": "param", "name": "windowName", "lineNumber": 4, "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "incognito window name", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 22, "offset": 21 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 22, "offset": 21 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 22, "offset": 21 } } }, "type": { "type": "NameExpression", "name": "string" } } ], "properties": [], "returns": [], "sees": [], "throws": [], "todos": [], "yields": [], "name": "closeIncognitoWindow", "kind": "function", "async": true, "memberof": "taiko", "scope": "static", "members": { "global": [], "inner": [], "instance": [], "events": [], "static": [] }, "path": [ { "name": "closeIncognitoWindow", "kind": "function", "scope": "static" } ], "namespace": ".closeIncognitoWindow" }, { "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Closes the given tab with given URL or closes current tab.", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 59, "offset": 58 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 59, "offset": 58 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 59, "offset": 58 } } }, "tags": [ { "title": "example", "description": "# Closes the current tab.\nawait closeTab()\n# Closes all the tabs with Title 'Open Source Test Automation Framework | Gauge'.\nawait closeTab('Open Source Test Automation Framework | Gauge')\n# Closes all the tabs with URL 'https://gauge.org'.\nawait closeTab('https://gauge.org')\n# Closes all the tabs with Regex Title 'Go*gle'\nawait closeTab(/Go*gle/)\n# Closes all the tabs with Regex URL '/http(s?):\\/\\/(www?).google.(com|co.in|co.uk)/'\nawait closeTab(/http(s?):\\/\\/(www?).google.(com|co.in|co.uk)/)", "lineNumber": 3 }, { "title": "param", "description": "URL/Page title of the tab to close.", "lineNumber": 15, "type": { "type": "OptionalType", "expression": { "type": "NameExpression", "name": "string" } }, "name": "targetUrl", "default": "undefined" }, { "title": "returns", "description": null, "lineNumber": 17, "type": { "type": "NameExpression", "name": "Promise" } } ], "loc": { "start": { "line": 711, "column": 0 }, "end": { "line": 729, "column": 3 } }, "context": { "loc": { "start": { "line": 730, "column": 0 }, "end": { "line": 766, "column": 2 } }, "file": "/Users/fallenmax/code/github/taiko/lib/taiko.js" }, "augments": [], "examples": [ { "description": "# Closes the current tab.\nawait closeTab()\n# Closes all the tabs with Title 'Open Source Test Automation Framework | Gauge'.\nawait closeTab('Open Source Test Automation Framework | Gauge')\n# Closes all the tabs with URL 'https://gauge.org'.\nawait closeTab('https://gauge.org')\n# Closes all the tabs with Regex Title 'Go*gle'\nawait closeTab(/Go*gle/)\n# Closes all the tabs with Regex URL '/http(s?):\\/\\/(www?).google.(com|co.in|co.uk)/'\nawait closeTab(/http(s?):\\/\\/(www?).google.(com|co.in|co.uk)/)" } ], "implements": [], "params": [ { "title": "param", "name": "targetUrl", "lineNumber": 15, "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "URL/Page title of the tab to close.", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 36, "offset": 35 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 36, "offset": 35 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 36, "offset": 35 } } }, "type": { "type": "NameExpression", "name": "string" }, "default": "undefined" } ], "properties": [], "returns": [ { "description": { "type": "root", "children": [], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 1, "offset": 0 } } }, "title": "returns", "type": { "type": "NameExpression", "name": "Promise" } } ], "sees": [], "throws": [], "todos": [], "yields": [], "name": "closeTab", "kind": "function", "async": true, "memberof": "taiko", "scope": "static", "members": { "global": [], "inner": [], "instance": [], "events": [], "static": [] }, "path": [ { "name": "closeTab", "kind": "function", "scope": "static" } ], "namespace": ".closeTab" }, { "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Override specific permissions to the given origin", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 50, "offset": 49 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 50, "offset": 49 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 50, "offset": 49 } } }, "tags": [ { "title": "example", "description": "await overridePermissions('http://maps.google.com',['geolocation']);", "lineNumber": 3 }, { "title": "param", "description": "url origin to override permissions", "lineNumber": 6, "type": { "type": "NameExpression", "name": "string" }, "name": "origin" }, { "title": "param", "description": "See [chrome devtools permission types](https://chromedevtools.github.io/devtools-protocol/tot/Browser/#type-PermissionType) for a list of permission types.", "lineNumber": 7, "type": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "NameExpression", "name": "string" } ] }, "name": "permissions" }, { "title": "returns", "description": null, "lineNumber": 9, "type": { "type": "NameExpression", "name": "Promise" } } ], "loc": { "start": { "line": 767, "column": 0 }, "end": { "line": 777, "column": 3 } }, "context": { "loc": { "start": { "line": 778, "column": 0 }, "end": { "line": 782, "column": 2 } }, "file": "/Users/fallenmax/code/github/taiko/lib/taiko.js" }, "augments": [], "examples": [ { "description": "await overridePermissions('http://maps.google.com',['geolocation']);" } ], "implements": [], "params": [ { "title": "param", "name": "origin", "lineNumber": 6, "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "url origin to override permissions", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 35, "offset": 34 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 35, "offset": 34 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 35, "offset": 34 } } }, "type": { "type": "NameExpression", "name": "string" } }, { "title": "param", "name": "permissions", "lineNumber": 7, "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "See ", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 5, "offset": 4 }, "indent": [] } }, { "type": "link", "title": null, "url": "https://chromedevtools.github.io/devtools-protocol/tot/Browser/#type-PermissionType", "children": [ { "type": "text", "value": "chrome devtools permission types", "position": { "start": { "line": 1, "column": 6, "offset": 5 }, "end": { "line": 1, "column": 38, "offset": 37 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 5, "offset": 4 }, "end": { "line": 1, "column": 124, "offset": 123 }, "indent": [] } }, { "type": "text", "value": " for a list of permission types.", "position": { "start": { "line": 1, "column": 124, "offset": 123 }, "end": { "line": 1, "column": 156, "offset": 155 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 156, "offset": 155 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 156, "offset": 155 } } }, "type": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "NameExpression", "name": "string" } ] } } ], "properties": [], "returns": [ { "description": { "type": "root", "children": [], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 1, "offset": 0 } } }, "title": "returns", "type": { "type": "NameExpression", "name": "Promise" } } ], "sees": [], "throws": [], "todos": [], "yields": [], "name": "overridePermissions", "kind": "function", "async": true, "memberof": "taiko", "scope": "static", "members": { "global": [], "inner": [], "instance": [], "events": [], "static": [] }, "path": [ { "name": "overridePermissions", "kind": "function", "scope": "static" } ], "namespace": ".overridePermissions" }, { "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Clears all permission overrides for all origins.", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 49, "offset": 48 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 49, "offset": 48 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 49, "offset": 48 } } }, "tags": [ { "title": "example", "description": "await clearPermissionOverrides()", "lineNumber": 3 }, { "title": "returns", "description": null, "lineNumber": 6, "type": { "type": "NameExpression", "name": "Promise" } } ], "loc": { "start": { "line": 783, "column": 0 }, "end": { "line": 790, "column": 3 } }, "context": { "loc": { "start": { "line": 791, "column": 0 }, "end": { "line": 795, "column": 2 } }, "file": "/Users/fallenmax/code/github/taiko/lib/taiko.js" }, "augments": [], "examples": [ { "description": "await clearPermissionOverrides()" } ], "implements": [], "params": [], "properties": [], "returns": [ { "description": { "type": "root", "children": [], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 1, "offset": 0 } } }, "title": "returns", "type": { "type": "NameExpression", "name": "Promise" } } ], "sees": [], "throws": [], "todos": [], "yields": [], "name": "clearPermissionOverrides", "kind": "function", "async": true, "memberof": "taiko", "scope": "static", "members": { "global": [], "inner": [], "instance": [], "events": [], "static": [] }, "path": [ { "name": "clearPermissionOverrides", "kind": "function", "scope": "static" } ], "namespace": ".clearPermissionOverrides" }, { "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Sets a cookie with the given cookie data. It may overwrite equivalent cookie if it already exists.", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 99, "offset": 98 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 99, "offset": 98 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 99, "offset": 98 } } }, "tags": [ { "title": "example", "description": "await setCookie(\"CSRFToken\",\"csrfToken\", {url: \"http://the-internet.herokuapp.com\"})\nawait setCookie(\"CSRFToken\",\"csrfToken\", {domain: \"herokuapp.com\"})", "lineNumber": 3 }, { "title": "param", "description": "Cookie name.", "lineNumber": 7, "type": { "type": "NameExpression", "name": "string" }, "name": "name" }, { "title": "param", "description": "Cookie value.", "lineNumber": 8, "type": { "type": "NameExpression", "name": "string" }, "name": "value" }, { "title": "param", "description": null, "lineNumber": 9, "type": { "type": "NameExpression", "name": "Object" }, "name": "options" }, { "title": "param", "description": "sets cookie with the URL.", "lineNumber": 10, "type": { "type": "OptionalType", "expression": { "type": "NameExpression", "name": "string" } }, "name": "options.url", "default": "undefined" }, { "title": "param", "description": "sets cookie with the exact domain.", "lineNumber": 11, "type": { "type": "OptionalType", "expression": { "type": "NameExpression", "name": "string" } }, "name": "options.domain", "default": "undefined" }, { "title": "param", "description": "sets cookie with the exact path.", "lineNumber": 12, "type": { "type": "OptionalType", "expression": { "type": "NameExpression", "name": "string" } }, "name": "options.path", "default": "undefined" }, { "title": "param", "description": "True if cookie to be set is secure.", "lineNumber": 13, "type": { "type": "OptionalType", "expression": { "type": "NameExpression", "name": "boolean" } }, "name": "options.secure", "default": "undefined" }, { "title": "param", "description": "True if cookie to be set is http-only.", "lineNumber": 14, "type": { "type": "OptionalType", "expression": { "type": "NameExpression", "name": "boolean" } }, "name": "options.httpOnly", "default": "undefined" }, { "title": "param", "description": "Represents the cookie's 'SameSite' status: Refer https://tools.ietf.org/html/draft-west-first-party-cookies.", "lineNumber": 15, "type": { "type": "OptionalType", "expression": { "type": "NameExpression", "name": "string" } }, "name": "options.sameSite", "default": "undefined" }, { "title": "param", "description": "UTC time in seconds, counted from January 1, 1970. eg: 2019-02-16T16:55:45.529Z", "lineNumber": 16, "type": { "type": "OptionalType", "expression": { "type": "NameExpression", "name": "number" } }, "name": "options.expires", "default": "undefined" }, { "title": "returns", "description": null, "lineNumber": 18, "type": { "type": "NameExpression", "name": "Promise" } } ], "loc": { "start": { "line": 796, "column": 0 }, "end": { "line": 815, "column": 3 } }, "context": { "loc": { "start": { "line": 816, "column": 0 }, "end": { "line": 828, "column": 2 } }, "file": "/Users/fallenmax/code/github/taiko/lib/taiko.js" }, "augments": [], "examples": [ { "description": "await setCookie(\"CSRFToken\",\"csrfToken\", {url: \"http://the-internet.herokuapp.com\"})\nawait setCookie(\"CSRFToken\",\"csrfToken\", {domain: \"herokuapp.com\"})" } ], "implements": [], "params": [ { "title": "param", "name": "name", "lineNumber": 7, "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Cookie name.", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 13, "offset": 12 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 13, "offset": 12 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 13, "offset": 12 } } }, "type": { "type": "NameExpression", "name": "string" } }, { "title": "param", "name": "value", "lineNumber": 8, "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Cookie value.", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 14, "offset": 13 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 14, "offset": 13 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 14, "offset": 13 } } }, "type": { "type": "NameExpression", "name": "string" } }, { "title": "param", "name": "options", "lineNumber": 9, "type": { "type": "NameExpression", "name": "Object" }, "properties": [ { "title": "param", "name": "options.url", "lineNumber": 10, "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "sets cookie with the URL.", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 26, "offset": 25 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 26, "offset": 25 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 26, "offset": 25 } } }, "type": { "type": "NameExpression", "name": "string" }, "default": "undefined" }, { "title": "param", "name": "options.domain", "lineNumber": 11, "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "sets cookie with the exact domain.", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 35, "offset": 34 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 35, "offset": 34 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 35, "offset": 34 } } }, "type": { "type": "NameExpression", "name": "string" }, "default": "undefined" }, { "title": "param", "name": "options.path", "lineNumber": 12, "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "sets cookie with the exact path.", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 33, "offset": 32 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 33, "offset": 32 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 33, "offset": 32 } } }, "type": { "type": "NameExpression", "name": "string" }, "default": "undefined" }, { "title": "param", "name": "options.secure", "lineNumber": 13, "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "True if cookie to be set is secure.", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 36, "offset": 35 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 36, "offset": 35 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 36, "offset": 35 } } }, "type": { "type": "NameExpression", "name": "boolean" }, "default": "undefined" }, { "title": "param", "name": "options.httpOnly", "lineNumber": 14, "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "True if cookie to be set is http-only.", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 39, "offset": 38 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 39, "offset": 38 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 39, "offset": 38 } } }, "type": { "type": "NameExpression", "name": "boolean" }, "default": "undefined" }, { "title": "param", "name": "options.sameSite", "lineNumber": 15, "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Represents the cookie's 'SameSite' status: Refer ", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 50, "offset": 49 }, "indent": [] } }, { "type": "link", "title": null, "url": "https://tools.ietf.org/html/draft-west-first-party-cookies", "children": [ { "type": "text", "value": "https://tools.ietf.org/html/draft-west-first-party-cookies", "position": { "start": { "line": 1, "column": 50, "offset": 49 }, "end": { "line": 1, "column": 108, "offset": 107 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 50, "offset": 49 }, "end": { "line": 1, "column": 108, "offset": 107 }, "indent": [] } }, { "type": "text", "value": ".", "position": { "start": { "line": 1, "column": 108, "offset": 107 }, "end": { "line": 1, "column": 109, "offset": 108 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 109, "offset": 108 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 109, "offset": 108 } } }, "type": { "type": "NameExpression", "name": "string" }, "default": "undefined" }, { "title": "param", "name": "options.expires", "lineNumber": 16, "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "UTC time in seconds, counted from January 1, 1970. eg: 2019-02-16T16:55:45.529Z", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 80, "offset": 79 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 80, "offset": 79 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 80, "offset": 79 } } }, "type": { "type": "NameExpression", "name": "number" }, "default": "undefined" } ], "default": "{}" } ], "properties": [], "returns": [ { "description": { "type": "root", "children": [], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 1, "offset": 0 } } }, "title": "returns", "type": { "type": "NameExpression", "name": "Promise" } } ], "sees": [], "throws": [], "todos": [], "yields": [], "name": "setCookie", "kind": "function", "async": true, "memberof": "taiko", "scope": "static", "members": { "global": [], "inner": [], "instance": [], "events": [], "static": [] }, "path": [ { "name": "setCookie", "kind": "function", "scope": "static" } ], "namespace": ".setCookie" }, { "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Deletes browser cookies with matching name and URL or domain/path pair. If cookie name is not given or empty, all browser cookies are deleted.", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 143, "offset": 142 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 143, "offset": 142 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 143, "offset": 142 } } }, "tags": [ { "title": "example", "description": "await deleteCookies() # clears all browser cookies\nawait deleteCookies(\"CSRFToken\", {url: \"http://the-internet.herokuapp.com\"})\nawait deleteCookies(\"CSRFToken\", {domain: \"herokuapp.com\"})", "lineNumber": 3 }, { "title": "param", "description": "Cookie name.", "lineNumber": 8, "type": { "type": "OptionalType", "expression": { "type": "NameExpression", "name": "string" } }, "name": "cookieName", "default": "undefined" }, { "title": "param", "description": null, "lineNumber": 9, "type": { "type": "NameExpression", "name": "Object" }, "name": "options" }, { "title": "param", "description": "deletes all the cookies with the given name where domain and path match provided URL. eg: https://google.com", "lineNumber": 10, "type": { "type": "OptionalType", "expression": { "type": "NameExpression", "name": "string" } }, "name": "options.url", "default": "undefined" }, { "title": "param", "description": "deletes only cookies with the exact domain. eg: google.com", "lineNumber": 11, "type": { "type": "OptionalType", "expression": { "type": "NameExpression", "name": "string" } }, "name": "options.domain", "default": "undefined" }, { "title": "param", "description": "deletes only cookies with the exact path. eg: Google/Chrome/Default/Cookies/..", "lineNumber": 12, "type": { "type": "OptionalType", "expression": { "type": "NameExpression", "name": "string" } }, "name": "options.path", "default": "undefined" }, { "title": "returns", "description": null, "lineNumber": 14, "type": { "type": "NameExpression", "name": "Promise" } } ], "loc": { "start": { "line": 829, "column": 0 }, "end": { "line": 844, "column": 3 } }, "context": { "loc": { "start": { "line": 845, "column": 0 }, "end": { "line": 859, "column": 2 } }, "file": "/Users/fallenmax/code/github/taiko/lib/taiko.js" }, "augments": [], "examples": [ { "description": "await deleteCookies() # clears all browser cookies\nawait deleteCookies(\"CSRFToken\", {url: \"http://the-internet.herokuapp.com\"})\nawait deleteCookies(\"CSRFToken\", {domain: \"herokuapp.com\"})" } ], "implements": [], "params": [ { "title": "param", "name": "cookieName", "lineNumber": 8, "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Cookie name.", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 13, "offset": 12 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 13, "offset": 12 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 13, "offset": 12 } } }, "type": { "type": "NameExpression", "name": "string" }, "default": "undefined" }, { "title": "param", "name": "options", "lineNumber": 9, "type": { "type": "NameExpression", "name": "Object" }, "properties": [ { "title": "param", "name": "options.url", "lineNumber": 10, "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "deletes all the cookies with the given name where domain and path match provided URL. eg: ", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 91, "offset": 90 }, "indent": [] } }, { "type": "link", "title": null, "url": "https://google.com", "children": [ { "type": "text", "value": "https://google.com", "position": { "start": { "line": 1, "column": 91, "offset": 90 }, "end": { "line": 1, "column": 109, "offset": 108 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 91, "offset": 90 }, "end": { "line": 1, "column": 109, "offset": 108 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 109, "offset": 108 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 109, "offset": 108 } } }, "type": { "type": "NameExpression", "name": "string" }, "default": "undefined" }, { "title": "param", "name": "options.domain", "lineNumber": 11, "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "deletes only cookies with the exact domain. eg: google.com", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 59, "offset": 58 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 59, "offset": 58 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 59, "offset": 58 } } }, "type": { "type": "NameExpression", "name": "string" }, "default": "undefined" }, { "title": "param", "name": "options.path", "lineNumber": 12, "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "deletes only cookies with the exact path. eg: Google/Chrome/Default/Cookies/..", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 79, "offset": 78 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 79, "offset": 78 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 79, "offset": 78 } } }, "type": { "type": "NameExpression", "name": "string" }, "default": "undefined" } ], "default": "{}" } ], "properties": [], "returns": [ { "description": { "type": "root", "children": [], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 1, "offset": 0 } } }, "title": "returns", "type": { "type": "NameExpression", "name": "Promise" } } ], "sees": [], "throws": [], "todos": [], "yields": [], "name": "deleteCookies", "kind": "function", "async": true, "memberof": "taiko", "scope": "static", "members": { "global": [], "inner": [], "instance": [], "events": [], "static": [] }, "path": [ { "name": "deleteCookies", "kind": "function", "scope": "static" } ], "namespace": ".deleteCookies" }, { "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Get browser cookies", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 20, "offset": 19 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 20, "offset": 19 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 20, "offset": 19 } } }, "tags": [ { "title": "example", "description": "await getCookies()\nawait getCookies({urls:['https://the-internet.herokuapp.com']})", "lineNumber": 3 }, { "title": "param", "description": null, "lineNumber": 7, "type": { "type": "NameExpression", "name": "Object" }, "name": "options" }, { "title": "param", "description": "The list of URLs for which applicable cookies will be fetched", "lineNumber": 8, "type": { "type": "OptionalType", "expression": { "type": "NameExpression", "name": "Array" } }, "name": "options.urls", "default": "undefined" }, { "title": "returns", "description": "Array of cookie objects", "lineNumber": 10, "type": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Promise" }, "applications": [ { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "NameExpression", "name": "Object" } ] } ] } } ], "loc": { "start": { "line": 860, "column": 0 }, "end": { "line": 871, "column": 3 } }, "context": { "loc": { "start": { "line": 872, "column": 0 }, "end": { "line": 875, "column": 2 } }, "file": "/Users/fallenmax/code/github/taiko/lib/taiko.js" }, "augments": [], "examples": [ { "description": "await getCookies()\nawait getCookies({urls:['https://the-internet.herokuapp.com']})" } ], "implements": [], "params": [ { "title": "param", "name": "options", "lineNumber": 7, "type": { "type": "NameExpression", "name": "Object" }, "properties": [ { "title": "param", "name": "options.urls", "lineNumber": 8, "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "The list of URLs for which applicable cookies will be fetched", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 62, "offset": 61 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 62, "offset": 61 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 62, "offset": 61 } } }, "type": { "type": "NameExpression", "name": "Array" }, "default": "undefined" } ], "default": "{}" } ], "properties": [], "returns": [ { "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Array of cookie objects", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 24, "offset": 23 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 24, "offset": 23 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 24, "offset": 23 } } }, "title": "returns", "type": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Promise" }, "applications": [ { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "NameExpression", "name": "Object" } ] } ] } } ], "sees": [], "throws": [], "todos": [], "yields": [], "name": "getCookies", "kind": "function", "async": true, "memberof": "taiko", "scope": "static", "members": { "global": [], "inner": [], "instance": [], "events": [], "static": [] }, "path": [ { "name": "getCookies", "kind": "function", "scope": "static" } ], "namespace": ".getCookies" }, { "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Overrides the Geolocation Position", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 35, "offset": 34 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 35, "offset": 34 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 35, "offset": 34 } } }, "tags": [ { "title": "example", "description": "await setLocation({ latitude: 27.1752868, longitude: 78.040009, accuracy:20 })", "lineNumber": 3 }, { "title": "param", "description": "Latitue, logitude and accuracy to set the location.", "lineNumber": 6, "type": { "type": "NameExpression", "name": "Object" }, "name": "options" }, { "title": "param", "description": "Mock latitude", "lineNumber": 7, "type": { "type": "NameExpression", "name": "number" }, "name": "options.latitude" }, { "title": "param", "description": "Mock longitude", "lineNumber": 8, "type": { "type": "NameExpression", "name": "number" }, "name": "options.longitude" }, { "title": "param", "description": "Mock accuracy", "lineNumber": 9, "type": { "type": "NameExpression", "name": "number" }, "name": "options.accuracy" }, { "title": "returns", "description": null, "lineNumber": 11, "type": { "type": "NameExpression", "name": "Promise" } } ], "loc": { "start": { "line": 876, "column": 0 }, "end": { "line": 888, "column": 3 } }, "context": { "loc": { "start": { "line": 889, "column": 0 }, "end": { "line": 893, "column": 2 } }, "file": "/Users/fallenmax/code/github/taiko/lib/taiko.js" }, "augments": [], "examples": [ { "description": "await setLocation({ latitude: 27.1752868, longitude: 78.040009, accuracy:20 })" } ], "implements": [], "params": [ { "title": "param", "name": "options", "lineNumber": 6, "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Latitue, logitude and accuracy to set the location.", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 52, "offset": 51 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 52, "offset": 51 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 52, "offset": 51 } } }, "type": { "type": "NameExpression", "name": "Object" }, "properties": [ { "title": "param", "name": "options.latitude", "lineNumber": 7, "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Mock latitude", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 14, "offset": 13 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 14, "offset": 13 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 14, "offset": 13 } } }, "type": { "type": "NameExpression", "name": "number" } }, { "title": "param", "name": "options.longitude", "lineNumber": 8, "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Mock longitude", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 15, "offset": 14 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 15, "offset": 14 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 15, "offset": 14 } } }, "type": { "type": "NameExpression", "name": "number" } }, { "title": "param", "name": "options.accuracy", "lineNumber": 9, "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Mock accuracy", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 14, "offset": 13 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 14, "offset": 13 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 14, "offset": 13 } } }, "type": { "type": "NameExpression", "name": "number" } } ] } ], "properties": [], "returns": [ { "description": { "type": "root", "children": [], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 1, "offset": 0 } } }, "title": "returns", "type": { "type": "NameExpression", "name": "Promise" } } ], "sees": [], "throws": [], "todos": [], "yields": [], "name": "setLocation", "kind": "function", "async": true, "memberof": "taiko", "scope": "static", "members": { "global": [], "inner": [], "instance": [], "events": [], "static": [] }, "path": [ { "name": "setLocation", "kind": "function", "scope": "static" } ], "namespace": ".setLocation" }, { "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Opens the specified URL in the browser's tab. Adds ", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 52, "offset": 51 }, "indent": [] } }, { "type": "inlineCode", "value": "http", "position": { "start": { "line": 1, "column": 52, "offset": 51 }, "end": { "line": 1, "column": 58, "offset": 57 }, "indent": [] } }, { "type": "text", "value": " protocol to the URL if not present.", "position": { "start": { "line": 1, "column": 58, "offset": 57 }, "end": { "line": 1, "column": 94, "offset": 93 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 94, "offset": 93 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 94, "offset": 93 } } }, "tags": [ { "title": "example", "description": "await goto('https://google.com')\nawait goto('google.com')\nawait goto({ navigationTimeout:10000, headers:{'Authorization':'Basic cG9zdG1hbjpwYXNzd29y2A=='}})", "lineNumber": 2 }, { "title": "param", "description": "URL to navigate page to.", "lineNumber": 7, "type": { "type": "NameExpression", "name": "string" }, "name": "url" }, { "title": "param", "description": null, "lineNumber": 8, "type": { "type": "NameExpression", "name": "Object" }, "name": "options" }, { "title": "param", "description": "Wait for navigation after the goto. Default navigationTimeout is 30 seconds to override pass `{ navigationTimeout: 10000 }` in `options` parameter.", "lineNumber": 9, "type": { "type": "OptionalType", "expression": { "type": "NameExpression", "name": "boolean" } }, "name": "options.waitForNavigation", "default": "true" }, { "title": "param", "description": "Events available to wait for ['DOMContentLoaded', 'loadEventFired', 'networkAlmostIdle', 'networkIdle', 'firstPaint', 'firstContentfulPaint', 'firstMeaningfulPaint']", "lineNumber": 10, "type": { "type": "OptionalType", "expression": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "NameExpression", "name": "string" } ] } }, "name": "options.waitForEvents", "default": "['firstMeaningfulPaint']" }, { "title": "param", "description": "Navigation timeout value in milliseconds for navigation after click.", "lineNumber": 11, "type": { "type": "OptionalType", "expression": { "type": "NameExpression", "name": "number" } }, "name": "options.navigationTimeout", "default": "30000" }, { "title": "param", "description": "Map with extra HTTP headers.", "lineNumber": 12, "type": { "type": "NameExpression", "name": "Object" }, "name": "options.headers" }, { "title": "param", "description": "time to wait for navigation to start. Accepts value in milliseconds.", "lineNumber": 13, "type": { "type": "OptionalType", "expression": { "type": "NameExpression", "name": "number" } }, "name": "options.waitForStart", "default": "100" }, { "title": "returns", "description": null, "lineNumber": 15, "type": { "type": "NameExpression", "name": "Promise" } } ], "loc": { "start": { "line": 894, "column": 0 }, "end": { "line": 910, "column": 3 } }, "context": { "loc": { "start": { "line": 911, "column": 0 }, "end": { "line": 924, "column": 2 } }, "file": "/Users/fallenmax/code/github/taiko/lib/taiko.js" }, "augments": [], "examples": [ { "description": "await goto('https://google.com')\nawait goto('google.com')\nawait goto({ navigationTimeout:10000, headers:{'Authorization':'Basic cG9zdG1hbjpwYXNzd29y2A=='}})" } ], "implements": [], "params": [ { "title": "param", "name": "url", "lineNumber": 7, "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "URL to navigate page to.", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 25, "offset": 24 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 25, "offset": 24 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 25, "offset": 24 } } }, "type": { "type": "NameExpression", "name": "string" } }, { "title": "param", "name": "options", "lineNumber": 8, "type": { "type": "NameExpression", "name": "Object" }, "properties": [ { "title": "param", "name": "options.waitForNavigation", "lineNumber": 9, "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Wait for navigation after the goto. Default navigationTimeout is 30 seconds to override pass ", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 94, "offset": 93 }, "indent": [] } }, { "type": "inlineCode", "value": "{ navigationTimeout: 10000 }", "position": { "start": { "line": 1, "column": 94, "offset": 93 }, "end": { "line": 1, "column": 124, "offset": 123 }, "indent": [] } }, { "type": "text", "value": " in ", "position": { "start": { "line": 1, "column": 124, "offset": 123 }, "end": { "line": 1, "column": 128, "offset": 127 }, "indent": [] } }, { "type": "inlineCode", "value": "options", "position": { "start": { "line": 1, "column": 128, "offset": 127 }, "end": { "line": 1, "column": 137, "offset": 136 }, "indent": [] } }, { "type": "text", "value": " parameter.", "position": { "start": { "line": 1, "column": 137, "offset": 136 }, "end": { "line": 1, "column": 148, "offset": 147 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 148, "offset": 147 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 148, "offset": 147 } } }, "type": { "type": "NameExpression", "name": "boolean" }, "default": "true" }, { "title": "param", "name": "options.waitForEvents", "lineNumber": 10, "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Events available to wait for ", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 30, "offset": 29 }, "indent": [] } }, { "type": "linkReference", "identifier": "'domcontentloaded', 'loadeventfired', 'networkalmostidle', 'networkidle', 'firstpaint', 'firstcontentfulpaint', 'firstmeaningfulpaint'", "referenceType": "shortcut", "children": [ { "type": "text", "value": "'DOMContentLoaded', 'loadEventFired', 'networkAlmostIdle', 'networkIdle', 'firstPaint', 'firstContentfulPaint', 'firstMeaningfulPaint'", "position": { "start": { "line": 1, "column": 31, "offset": 30 }, "end": { "line": 1, "column": 165, "offset": 164 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 30, "offset": 29 }, "end": { "line": 1, "column": 166, "offset": 165 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 166, "offset": 165 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 166, "offset": 165 } } }, "type": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "NameExpression", "name": "string" } ] }, "default": "['firstMeaningfulPaint']" }, { "title": "param", "name": "options.navigationTimeout", "lineNumber": 11, "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Navigation timeout value in milliseconds for navigation after click.", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 69, "offset": 68 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 69, "offset": 68 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 69, "offset": 68 } } }, "type": { "type": "NameExpression", "name": "number" }, "default": "30000" }, { "title": "param", "name": "options.headers", "lineNumber": 12, "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Map with extra HTTP headers.", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 29, "offset": 28 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 29, "offset": 28 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 29, "offset": 28 } } }, "type": { "type": "NameExpression", "name": "Object" } }, { "title": "param", "name": "options.waitForStart", "lineNumber": 13, "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "time to wait for navigation to start. Accepts value in milliseconds.", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 69, "offset": 68 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 69, "offset": 68 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 69, "offset": 68 } } }, "type": { "type": "NameExpression", "name": "number" }, "default": "100" } ], "default": "{navigationTimeout:defaultConfig.navigationTimeout}" } ], "properties": [], "returns": [ { "description": { "type": "root", "children": [], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 1, "offset": 0 } } }, "title": "returns", "type": { "type": "NameExpression", "name": "Promise" } } ], "sees": [], "throws": [], "todos": [], "yields": [], "name": "goto", "kind": "function", "async": true, "memberof": "taiko", "scope": "static", "members": { "global": [], "inner": [], "instance": [], "events": [], "static": [] }, "path": [ { "name": "goto", "kind": "function", "scope": "static" } ], "namespace": ".goto" }, { "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Reloads the page.", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 18, "offset": 17 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 18, "offset": 17 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 18, "offset": 17 } } }, "tags": [ { "title": "example", "description": "await reload('https://google.com')\nawait reload('https://google.com', { navigationTimeout: 10000 })", "lineNumber": 2 }, { "title": "param", "description": "DEPRECATED URL to reload", "lineNumber": 6, "type": { "type": "NameExpression", "name": "string" }, "name": "url" }, { "title": "param", "description": null, "lineNumber": 7, "type": { "type": "NameExpression", "name": "Object" }, "name": "options" }, { "title": "param", "description": "Wait for navigation after the reload. Default navigation timeout is 30 seconds, to override pass `{ navigationTimeout: 10000 }` in `options` parameter.", "lineNumber": 8, "type": { "type": "OptionalType", "expression": { "type": "NameExpression", "name": "boolean" } }, "name": "options.waitForNavigation", "default": "true" }, { "title": "param", "description": "Events available to wait for ['DOMContentLoaded', 'loadEventFired', 'networkAlmostIdle', 'networkIdle', 'firstPaint', 'firstContentfulPaint', 'firstMeaningfulPaint']", "lineNumber": 9, "type": { "type": "OptionalType", "expression": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "NameExpression", "name": "string" } ] } }, "name": "options.waitForEvents", "default": "['firstMeaningfulPaint']" }, { "title": "param", "description": "Navigation timeout value in milliseconds for navigation after click.", "lineNumber": 10, "type": { "type": "OptionalType", "expression": { "type": "NameExpression", "name": "number" } }, "name": "options.navigationTimeout", "default": "30000" }, { "title": "param", "description": "time to wait for navigation to start. Accepts value in milliseconds.", "lineNumber": 11, "type": { "type": "OptionalType", "expression": { "type": "NameExpression", "name": "number" } }, "name": "options.waitForStart", "default": "100" }, { "title": "param", "description": "Ignore Cache on reload - Default to false", "lineNumber": 12, "type": { "type": "OptionalType", "expression": { "type": "NameExpression", "name": "boolean" } }, "name": "options.ignoreCache", "default": "false" }, { "title": "returns", "description": null, "lineNumber": 14, "type": { "type": "NameExpression", "name": "Promise" } } ], "loc": { "start": { "line": 925, "column": 0 }, "end": { "line": 940, "column": 3 } }, "context": { "loc": { "start": { "line": 941, "column": 0 }, "end": { "line": 957, "column": 2 } }, "file": "/Users/fallenmax/code/github/taiko/lib/taiko.js" }, "augments": [], "examples": [ { "description": "await reload('https://google.com')\nawait reload('https://google.com', { navigationTimeout: 10000 })" } ], "implements": [], "params": [ { "title": "param", "name": "url", "lineNumber": 6, "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "DEPRECATED URL to reload", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 25, "offset": 24 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 25, "offset": 24 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 25, "offset": 24 } } }, "type": { "type": "NameExpression", "name": "string" } }, { "title": "param", "name": "options", "lineNumber": 7, "type": { "type": "NameExpression", "name": "Object" }, "properties": [ { "title": "param", "name": "options.waitForNavigation", "lineNumber": 8, "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Wait for navigation after the reload. Default navigation timeout is 30 seconds, to override pass ", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 98, "offset": 97 }, "indent": [] } }, { "type": "inlineCode", "value": "{ navigationTimeout: 10000 }", "position": { "start": { "line": 1, "column": 98, "offset": 97 }, "end": { "line": 1, "column": 128, "offset": 127 }, "indent": [] } }, { "type": "text", "value": " in ", "position": { "start": { "line": 1, "column": 128, "offset": 127 }, "end": { "line": 1, "column": 132, "offset": 131 }, "indent": [] } }, { "type": "inlineCode", "value": "options", "position": { "start": { "line": 1, "column": 132, "offset": 131 }, "end": { "line": 1, "column": 141, "offset": 140 }, "indent": [] } }, { "type": "text", "value": " parameter.", "position": { "start": { "line": 1, "column": 141, "offset": 140 }, "end": { "line": 1, "column": 152, "offset": 151 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 152, "offset": 151 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 152, "offset": 151 } } }, "type": { "type": "NameExpression", "name": "boolean" }, "default": "true" }, { "title": "param", "name": "options.waitForEvents", "lineNumber": 9, "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Events available to wait for ", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 30, "offset": 29 }, "indent": [] } }, { "type": "linkReference", "identifier": "'domcontentloaded', 'loadeventfired', 'networkalmostidle', 'networkidle', 'firstpaint', 'firstcontentfulpaint', 'firstmeaningfulpaint'", "referenceType": "shortcut", "children": [ { "type": "text", "value": "'DOMContentLoaded', 'loadEventFired', 'networkAlmostIdle', 'networkIdle', 'firstPaint', 'firstContentfulPaint', 'firstMeaningfulPaint'", "position": { "start": { "line": 1, "column": 31, "offset": 30 }, "end": { "line": 1, "column": 165, "offset": 164 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 30, "offset": 29 }, "end": { "line": 1, "column": 166, "offset": 165 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 166, "offset": 165 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 166, "offset": 165 } } }, "type": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "NameExpression", "name": "string" } ] }, "default": "['firstMeaningfulPaint']" }, { "title": "param", "name": "options.navigationTimeout", "lineNumber": 10, "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Navigation timeout value in milliseconds for navigation after click.", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 69, "offset": 68 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 69, "offset": 68 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 69, "offset": 68 } } }, "type": { "type": "NameExpression", "name": "number" }, "default": "30000" }, { "title": "param", "name": "options.waitForStart", "lineNumber": 11, "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "time to wait for navigation to start. Accepts value in milliseconds.", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 69, "offset": 68 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 69, "offset": 68 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 69, "offset": 68 } } }, "type": { "type": "NameExpression", "name": "number" }, "default": "100" }, { "title": "param", "name": "options.ignoreCache", "lineNumber": 12, "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Ignore Cache on reload - Default to false", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 42, "offset": 41 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 42, "offset": 41 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 42, "offset": 41 } } }, "type": { "type": "NameExpression", "name": "boolean" }, "default": "false" } ], "default": "{navigationTimeout:defaultConfig.navigationTimeout}" } ], "properties": [], "returns": [ { "description": { "type": "root", "children": [], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 1, "offset": 0 } } }, "title": "returns", "type": { "type": "NameExpression", "name": "Promise" } } ], "sees": [], "throws": [], "todos": [], "yields": [], "name": "reload", "kind": "function", "async": true, "memberof": "taiko", "scope": "static", "members": { "global": [], "inner": [], "instance": [], "events": [], "static": [] }, "path": [ { "name": "reload", "kind": "function", "scope": "static" } ], "namespace": ".reload" }, { "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Mimics browser back button click functionality.", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 48, "offset": 47 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 48, "offset": 47 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 48, "offset": 47 } } }, "tags": [ { "title": "example", "description": "await goBack()", "lineNumber": 2 }, { "title": "param", "description": null, "lineNumber": 5, "type": { "type": "NameExpression", "name": "Object" }, "name": "options" }, { "title": "param", "description": "Wait for navigation after the goBack. Default navigation timeout is 30 seconds, to override pass `{ navigationTimeout: 10000 }` in `options` parameter.", "lineNumber": 6, "type": { "type": "OptionalType", "expression": { "type": "NameExpression", "name": "boolean" } }, "name": "options.waitForNavigation", "default": "true" }, { "title": "param", "description": "Events available to wait for ['DOMContentLoaded', 'loadEventFired', 'networkAlmostIdle', 'networkIdle', 'firstPaint', 'firstContentfulPaint', 'firstMeaningfulPaint']", "lineNumber": 7, "type": { "type": "OptionalType", "expression": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "NameExpression", "name": "string" } ] } }, "name": "options.waitForEvents", "default": "['firstMeaningfulPaint']" }, { "title": "param", "description": "Navigation timeout value in milliseconds for navigation after click.", "lineNumber": 8, "type": { "type": "OptionalType", "expression": { "type": "NameExpression", "name": "number" } }, "name": "options.navigationTimeout", "default": "30000" }, { "title": "param", "description": "time to wait for navigation to start. Accepts value in milliseconds.", "lineNumber": 9, "type": { "type": "OptionalType", "expression": { "type": "NameExpression", "name": "number" } }, "name": "options.waitForStart", "default": "100" }, { "title": "returns", "description": null, "lineNumber": 11, "type": { "type": "NameExpression", "name": "Promise" } } ], "loc": { "start": { "line": 958, "column": 0 }, "end": { "line": 970, "column": 3 } }, "context": { "loc": { "start": { "line": 971, "column": 0 }, "end": { "line": 975, "column": 2 } }, "file": "/Users/fallenmax/code/github/taiko/lib/taiko.js" }, "augments": [], "examples": [ { "description": "await goBack()" } ], "implements": [], "params": [ { "title": "param", "name": "options", "lineNumber": 5, "type": { "type": "NameExpression", "name": "Object" }, "properties": [ { "title": "param", "name": "options.waitForNavigation", "lineNumber": 6, "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Wait for navigation after the goBack. Default navigation timeout is 30 seconds, to override pass ", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 98, "offset": 97 }, "indent": [] } }, { "type": "inlineCode", "value": "{ navigationTimeout: 10000 }", "position": { "start": { "line": 1, "column": 98, "offset": 97 }, "end": { "line": 1, "column": 128, "offset": 127 }, "indent": [] } }, { "type": "text", "value": " in ", "position": { "start": { "line": 1, "column": 128, "offset": 127 }, "end": { "line": 1, "column": 132, "offset": 131 }, "indent": [] } }, { "type": "inlineCode", "value": "options", "position": { "start": { "line": 1, "column": 132, "offset": 131 }, "end": { "line": 1, "column": 141, "offset": 140 }, "indent": [] } }, { "type": "text", "value": " parameter.", "position": { "start": { "line": 1, "column": 141, "offset": 140 }, "end": { "line": 1, "column": 152, "offset": 151 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 152, "offset": 151 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 152, "offset": 151 } } }, "type": { "type": "NameExpression", "name": "boolean" }, "default": "true" }, { "title": "param", "name": "options.waitForEvents", "lineNumber": 7, "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Events available to wait for ", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 30, "offset": 29 }, "indent": [] } }, { "type": "linkReference", "identifier": "'domcontentloaded', 'loadeventfired', 'networkalmostidle', 'networkidle', 'firstpaint', 'firstcontentfulpaint', 'firstmeaningfulpaint'", "referenceType": "shortcut", "children": [ { "type": "text", "value": "'DOMContentLoaded', 'loadEventFired', 'networkAlmostIdle', 'networkIdle', 'firstPaint', 'firstContentfulPaint', 'firstMeaningfulPaint'", "position": { "start": { "line": 1, "column": 31, "offset": 30 }, "end": { "line": 1, "column": 165, "offset": 164 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 30, "offset": 29 }, "end": { "line": 1, "column": 166, "offset": 165 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 166, "offset": 165 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 166, "offset": 165 } } }, "type": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "NameExpression", "name": "string" } ] }, "default": "['firstMeaningfulPaint']" }, { "title": "param", "name": "options.navigationTimeout", "lineNumber": 8, "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Navigation timeout value in milliseconds for navigation after click.", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 69, "offset": 68 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 69, "offset": 68 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 69, "offset": 68 } } }, "type": { "type": "NameExpression", "name": "number" }, "default": "30000" }, { "title": "param", "name": "options.waitForStart", "lineNumber": 9, "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "time to wait for navigation to start. Accepts value in milliseconds.", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 69, "offset": 68 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 69, "offset": 68 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 69, "offset": 68 } } }, "type": { "type": "NameExpression", "name": "number" }, "default": "100" } ], "default": "{navigationTimeout:defaultConfig.navigationTimeout}" } ], "properties": [], "returns": [ { "description": { "type": "root", "children": [], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 1, "offset": 0 } } }, "title": "returns", "type": { "type": "NameExpression", "name": "Promise" } } ], "sees": [], "throws": [], "todos": [], "yields": [], "name": "goBack", "kind": "function", "async": true, "memberof": "taiko", "scope": "static", "members": { "global": [], "inner": [], "instance": [], "events": [], "static": [] }, "path": [ { "name": "goBack", "kind": "function", "scope": "static" } ], "namespace": ".goBack" }, { "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Mimics browser forward button click functionality.", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 51, "offset": 50 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 51, "offset": 50 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 51, "offset": 50 } } }, "tags": [ { "title": "example", "description": "await goForward()", "lineNumber": 2 }, { "title": "param", "description": null, "lineNumber": 5, "type": { "type": "NameExpression", "name": "Object" }, "name": "options" }, { "title": "param", "description": "Wait for navigation after the goForward. Default navigation timeout is 30 seconds, to override pass `{ navigationTimeout: 10000 }` in `options` parameter.", "lineNumber": 6, "type": { "type": "OptionalType", "expression": { "type": "NameExpression", "name": "boolean" } }, "name": "options.waitForNavigation", "default": "true" }, { "title": "param", "description": "Events available to wait for ['DOMContentLoaded', 'loadEventFired', 'networkAlmostIdle', 'networkIdle', 'firstPaint', 'firstContentfulPaint', 'firstMeaningfulPaint']", "lineNumber": 7, "type": { "type": "OptionalType", "expression": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "NameExpression", "name": "string" } ] } }, "name": "options.waitForEvents", "default": "['firstMeaningfulPaint']" }, { "title": "param", "description": "Navigation timeout value in milliseconds for navigation after click.", "lineNumber": 8, "type": { "type": "OptionalType", "expression": { "type": "NameExpression", "name": "number" } }, "name": "options.navigationTimeout", "default": "30000" }, { "title": "param", "description": "time to wait for navigation to start. Accepts value in milliseconds.", "lineNumber": 9, "type": { "type": "OptionalType", "expression": { "type": "NameExpression", "name": "number" } }, "name": "options.waitForStart", "default": "100" }, { "title": "returns", "description": null, "lineNumber": 11, "type": { "type": "NameExpression", "name": "Promise" } } ], "loc": { "start": { "line": 976, "column": 0 }, "end": { "line": 988, "column": 3 } }, "context": { "loc": { "start": { "line": 989, "column": 0 }, "end": { "line": 993, "column": 2 } }, "file": "/Users/fallenmax/code/github/taiko/lib/taiko.js" }, "augments": [], "examples": [ { "description": "await goForward()" } ], "implements": [], "params": [ { "title": "param", "name": "options", "lineNumber": 5, "type": { "type": "NameExpression", "name": "Object" }, "properties": [ { "title": "param", "name": "options.waitForNavigation", "lineNumber": 6, "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Wait for navigation after the goForward. Default navigation timeout is 30 seconds, to override pass ", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 101, "offset": 100 }, "indent": [] } }, { "type": "inlineCode", "value": "{ navigationTimeout: 10000 }", "position": { "start": { "line": 1, "column": 101, "offset": 100 }, "end": { "line": 1, "column": 131, "offset": 130 }, "indent": [] } }, { "type": "text", "value": " in ", "position": { "start": { "line": 1, "column": 131, "offset": 130 }, "end": { "line": 1, "column": 135, "offset": 134 }, "indent": [] } }, { "type": "inlineCode", "value": "options", "position": { "start": { "line": 1, "column": 135, "offset": 134 }, "end": { "line": 1, "column": 144, "offset": 143 }, "indent": [] } }, { "type": "text", "value": " parameter.", "position": { "start": { "line": 1, "column": 144, "offset": 143 }, "end": { "line": 1, "column": 155, "offset": 154 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 155, "offset": 154 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 155, "offset": 154 } } }, "type": { "type": "NameExpression", "name": "boolean" }, "default": "true" }, { "title": "param", "name": "options.waitForEvents", "lineNumber": 7, "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Events available to wait for ", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 30, "offset": 29 }, "indent": [] } }, { "type": "linkReference", "identifier": "'domcontentloaded', 'loadeventfired', 'networkalmostidle', 'networkidle', 'firstpaint', 'firstcontentfulpaint', 'firstmeaningfulpaint'", "referenceType": "shortcut", "children": [ { "type": "text", "value": "'DOMContentLoaded', 'loadEventFired', 'networkAlmostIdle', 'networkIdle', 'firstPaint', 'firstContentfulPaint', 'firstMeaningfulPaint'", "position": { "start": { "line": 1, "column": 31, "offset": 30 }, "end": { "line": 1, "column": 165, "offset": 164 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 30, "offset": 29 }, "end": { "line": 1, "column": 166, "offset": 165 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 166, "offset": 165 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 166, "offset": 165 } } }, "type": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "NameExpression", "name": "string" } ] }, "default": "['firstMeaningfulPaint']" }, { "title": "param", "name": "options.navigationTimeout", "lineNumber": 8, "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Navigation timeout value in milliseconds for navigation after click.", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 69, "offset": 68 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 69, "offset": 68 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 69, "offset": 68 } } }, "type": { "type": "NameExpression", "name": "number" }, "default": "30000" }, { "title": "param", "name": "options.waitForStart", "lineNumber": 9, "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "time to wait for navigation to start. Accepts value in milliseconds.", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 69, "offset": 68 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 69, "offset": 68 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 69, "offset": 68 } } }, "type": { "type": "NameExpression", "name": "number" }, "default": "100" } ], "default": "{navigationTimeout:defaultConfig.navigationTimeout}" } ], "properties": [], "returns": [ { "description": { "type": "root", "children": [], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 1, "offset": 0 } } }, "title": "returns", "type": { "type": "NameExpression", "name": "Promise" } } ], "sees": [], "throws": [], "todos": [], "yields": [], "name": "goForward", "kind": "function", "async": true, "memberof": "taiko", "scope": "static", "members": { "global": [], "inner": [], "instance": [], "events": [], "static": [] }, "path": [ { "name": "goForward", "kind": "function", "scope": "static" } ], "namespace": ".goForward" }, { "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Returns page's title.", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 22, "offset": 21 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 22, "offset": 21 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 22, "offset": 21 } } }, "tags": [ { "title": "example", "description": "await openBrowser();\nawait goto(\"www.google.com\");\nawait title(); # returns \"Google\"", "lineNumber": 2 }, { "title": "returns", "description": "The title of the current page.", "lineNumber": 7, "type": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Promise" }, "applications": [ { "type": "NameExpression", "name": "string" } ] } } ], "loc": { "start": { "line": 1024, "column": 0 }, "end": { "line": 1032, "column": 3 } }, "context": { "loc": { "start": { "line": 1033, "column": 0 }, "end": { "line": 1037, "column": 2 } }, "file": "/Users/fallenmax/code/github/taiko/lib/taiko.js" }, "augments": [], "examples": [ { "description": "await openBrowser();\nawait goto(\"www.google.com\");\nawait title(); # returns \"Google\"" } ], "implements": [], "params": [], "properties": [], "returns": [ { "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "The title of the current page.", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 31, "offset": 30 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 31, "offset": 30 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 31, "offset": 30 } } }, "title": "returns", "type": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Promise" }, "applications": [ { "type": "NameExpression", "name": "string" } ] } } ], "sees": [], "throws": [], "todos": [], "yields": [], "name": "title", "kind": "function", "async": true, "memberof": "taiko", "scope": "static", "members": { "global": [], "inner": [], "instance": [], "events": [], "static": [] }, "path": [ { "name": "title", "kind": "function", "scope": "static" } ], "namespace": ".title" }, { "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Accept or dismiss an ", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 22, "offset": 21 }, "indent": [] } }, { "type": "inlineCode", "value": "alert", "position": { "start": { "line": 1, "column": 22, "offset": 21 }, "end": { "line": 1, "column": 29, "offset": 28 }, "indent": [] } }, { "type": "text", "value": " matching a text.", "position": { "start": { "line": 1, "column": 29, "offset": 28 }, "end": { "line": 1, "column": 46, "offset": 45 }, "indent": [] } }, { "type": "html", "value": "
", "position": { "start": { "line": 1, "column": 46, "offset": 45 }, "end": { "line": 1, "column": 50, "offset": 49 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 50, "offset": 49 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 50, "offset": 49 } } }, "tags": [ { "title": "example", "description": "alert('Message', async () => await accept())\nalert('Message', async () => await dismiss())\n\n// Note: Taiko's `alert` listener has to be setup before the alert\n// displays on the page. For example, if clicking on a button\n// shows the alert, the Taiko script is\nalert('Message', async () => await accept())\nawait click('Show Alert')", "lineNumber": 3 }, { "title": "param", "description": "Identify alert based on this message.", "lineNumber": 13, "type": { "type": "NameExpression", "name": "string" }, "name": "message" }, { "title": "param", "description": "Action to perform. accept/dismiss.", "lineNumber": 14, "type": { "type": "NameExpression", "name": "function" }, "name": "callback" } ], "loc": { "start": { "line": 1057, "column": 0 }, "end": { "line": 1072, "column": 3 } }, "context": { "loc": { "start": { "line": 1073, "column": 0 }, "end": { "line": 1073, "column": 81 } }, "file": "/Users/fallenmax/code/github/taiko/lib/taiko.js" }, "augments": [], "examples": [ { "description": "alert('Message', async () => await accept())\nalert('Message', async () => await dismiss())\n\n// Note: Taiko's `alert` listener has to be setup before the alert\n// displays on the page. For example, if clicking on a button\n// shows the alert, the Taiko script is\nalert('Message', async () => await accept())\nawait click('Show Alert')" } ], "implements": [], "params": [ { "title": "param", "name": "message", "lineNumber": 13, "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Identify alert based on this message.", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 38, "offset": 37 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 38, "offset": 37 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 38, "offset": 37 } } }, "type": { "type": "NameExpression", "name": "string" } }, { "title": "param", "name": "callback", "lineNumber": 14, "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Action to perform. accept/dismiss.", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 35, "offset": 34 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 35, "offset": 34 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 35, "offset": 34 } } }, "type": { "type": "NameExpression", "name": "function" } } ], "properties": [], "returns": [], "sees": [], "throws": [], "todos": [], "yields": [], "name": "alert", "kind": "function", "memberof": "taiko", "scope": "static", "members": { "global": [], "inner": [], "instance": [], "events": [], "static": [] }, "path": [ { "name": "alert", "kind": "function", "scope": "static" } ], "namespace": ".alert" }, { "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Accept or dismiss a ", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 21, "offset": 20 }, "indent": [] } }, { "type": "inlineCode", "value": "prompt", "position": { "start": { "line": 1, "column": 21, "offset": 20 }, "end": { "line": 1, "column": 29, "offset": 28 }, "indent": [] } }, { "type": "text", "value": " matching a text.", "position": { "start": { "line": 1, "column": 29, "offset": 28 }, "end": { "line": 1, "column": 46, "offset": 45 }, "indent": [] } }, { "type": "html", "value": "
", "position": { "start": { "line": 1, "column": 46, "offset": 45 }, "end": { "line": 1, "column": 50, "offset": 49 }, "indent": [] } }, { "type": "text", "value": "\nWrite into the ", "position": { "start": { "line": 1, "column": 50, "offset": 49 }, "end": { "line": 2, "column": 16, "offset": 65 }, "indent": [ 1 ] } }, { "type": "inlineCode", "value": "prompt", "position": { "start": { "line": 2, "column": 16, "offset": 65 }, "end": { "line": 2, "column": 24, "offset": 73 }, "indent": [] } }, { "type": "text", "value": " with ", "position": { "start": { "line": 2, "column": 24, "offset": 73 }, "end": { "line": 2, "column": 30, "offset": 79 }, "indent": [] } }, { "type": "inlineCode", "value": "accept('Something')", "position": { "start": { "line": 2, "column": 30, "offset": 79 }, "end": { "line": 2, "column": 51, "offset": 100 }, "indent": [] } }, { "type": "text", "value": ".", "position": { "start": { "line": 2, "column": 51, "offset": 100 }, "end": { "line": 2, "column": 52, "offset": 101 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 2, "column": 52, "offset": 101 }, "indent": [ 1 ] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 2, "column": 52, "offset": 101 } } }, "tags": [ { "title": "example", "description": "prompt('Message', async () => await accept('Something'))\nprompt('Message', async () => await dismiss())\n\n// Note: Taiko's `prompt` listener has to be setup before the prompt\n// displays on the page. For example, if clicking on a button\n// shows the prompt, the Taiko script is\nprompt('Message', async () => await accept('Something'))\nawait click('Show Prompt')", "lineNumber": 4 }, { "title": "param", "description": "Identify prompt based on this message.", "lineNumber": 14, "type": { "type": "NameExpression", "name": "string" }, "name": "message" }, { "title": "param", "description": "Action to perform. accept/dismiss.", "lineNumber": 15, "type": { "type": "NameExpression", "name": "function" }, "name": "callback" } ], "loc": { "start": { "line": 1074, "column": 0 }, "end": { "line": 1090, "column": 3 } }, "context": { "loc": { "start": { "line": 1091, "column": 0 }, "end": { "line": 1091, "column": 83 } }, "file": "/Users/fallenmax/code/github/taiko/lib/taiko.js" }, "augments": [], "examples": [ { "description": "prompt('Message', async () => await accept('Something'))\nprompt('Message', async () => await dismiss())\n\n// Note: Taiko's `prompt` listener has to be setup before the prompt\n// displays on the page. For example, if clicking on a button\n// shows the prompt, the Taiko script is\nprompt('Message', async () => await accept('Something'))\nawait click('Show Prompt')" } ], "implements": [], "params": [ { "title": "param", "name": "message", "lineNumber": 14, "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Identify prompt based on this message.", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 39, "offset": 38 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 39, "offset": 38 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 39, "offset": 38 } } }, "type": { "type": "NameExpression", "name": "string" } }, { "title": "param", "name": "callback", "lineNumber": 15, "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Action to perform. accept/dismiss.", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 35, "offset": 34 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 35, "offset": 34 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 35, "offset": 34 } } }, "type": { "type": "NameExpression", "name": "function" } } ], "properties": [], "returns": [], "sees": [], "throws": [], "todos": [], "yields": [], "name": "prompt", "kind": "function", "memberof": "taiko", "scope": "static", "members": { "global": [], "inner": [], "instance": [], "events": [], "static": [] }, "path": [ { "name": "prompt", "kind": "function", "scope": "static" } ], "namespace": ".prompt" }, { "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Accept or dismiss a ", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 21, "offset": 20 }, "indent": [] } }, { "type": "inlineCode", "value": "confirm", "position": { "start": { "line": 1, "column": 21, "offset": 20 }, "end": { "line": 1, "column": 30, "offset": 29 }, "indent": [] } }, { "type": "text", "value": " popup matching a text.", "position": { "start": { "line": 1, "column": 30, "offset": 29 }, "end": { "line": 1, "column": 53, "offset": 52 }, "indent": [] } }, { "type": "html", "value": "
", "position": { "start": { "line": 1, "column": 53, "offset": 52 }, "end": { "line": 1, "column": 57, "offset": 56 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 57, "offset": 56 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 57, "offset": 56 } } }, "tags": [ { "title": "example", "description": "confirm('Message', async () => await accept())\nconfirm('Message', async () => await dismiss())\n\n// Note: Taiko's `confirm` listener has to be setup before the confirm\n// popup displays on the page. For example, if clicking on a button\n// shows the confirm popup, the Taiko script is\nconfirm('Message', async () => await accept())\nawait click('Show Confirm')", "lineNumber": 3 }, { "title": "param", "description": "Identify confirm based on this message.", "lineNumber": 13, "type": { "type": "NameExpression", "name": "string" }, "name": "message" }, { "title": "param", "description": "Action to perform. accept/dismiss.", "lineNumber": 14, "type": { "type": "NameExpression", "name": "function" }, "name": "callback" } ], "loc": { "start": { "line": 1092, "column": 0 }, "end": { "line": 1107, "column": 3 } }, "context": { "loc": { "start": { "line": 1108, "column": 0 }, "end": { "line": 1108, "column": 85 } }, "file": "/Users/fallenmax/code/github/taiko/lib/taiko.js" }, "augments": [], "examples": [ { "description": "confirm('Message', async () => await accept())\nconfirm('Message', async () => await dismiss())\n\n// Note: Taiko's `confirm` listener has to be setup before the confirm\n// popup displays on the page. For example, if clicking on a button\n// shows the confirm popup, the Taiko script is\nconfirm('Message', async () => await accept())\nawait click('Show Confirm')" } ], "implements": [], "params": [ { "title": "param", "name": "message", "lineNumber": 13, "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Identify confirm based on this message.", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 40, "offset": 39 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 40, "offset": 39 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 40, "offset": 39 } } }, "type": { "type": "NameExpression", "name": "string" } }, { "title": "param", "name": "callback", "lineNumber": 14, "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Action to perform. accept/dismiss.", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 35, "offset": 34 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 35, "offset": 34 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 35, "offset": 34 } } }, "type": { "type": "NameExpression", "name": "function" } } ], "properties": [], "returns": [], "sees": [], "throws": [], "todos": [], "yields": [], "name": "confirm", "kind": "function", "memberof": "taiko", "scope": "static", "members": { "global": [], "inner": [], "instance": [], "events": [], "static": [] }, "path": [ { "name": "confirm", "kind": "function", "scope": "static" } ], "namespace": ".confirm" }, { "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Accept or dismiss a ", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 21, "offset": 20 }, "indent": [] } }, { "type": "inlineCode", "value": "beforeunload", "position": { "start": { "line": 1, "column": 21, "offset": 20 }, "end": { "line": 1, "column": 35, "offset": 34 }, "indent": [] } }, { "type": "text", "value": " popup.", "position": { "start": { "line": 1, "column": 35, "offset": 34 }, "end": { "line": 1, "column": 42, "offset": 41 }, "indent": [] } }, { "type": "html", "value": "
", "position": { "start": { "line": 1, "column": 42, "offset": 41 }, "end": { "line": 1, "column": 46, "offset": 45 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 46, "offset": 45 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 46, "offset": 45 } } }, "tags": [ { "title": "example", "description": "beforeunload(async () => await accept())\nbeforeunload(async () => await dismiss())\n\n// Note: Taiko's `beforeunload` listener can be setup anywhere in the\n// script. The listener will run when the popup displays on the page.", "lineNumber": 3 }, { "title": "param", "description": "Action to perform. Accept/Dismiss.", "lineNumber": 10, "type": { "type": "NameExpression", "name": "function" }, "name": "callback" } ], "loc": { "start": { "line": 1109, "column": 0 }, "end": { "line": 1120, "column": 3 } }, "context": { "loc": { "start": { "line": 1121, "column": 0 }, "end": { "line": 1121, "column": 81 } }, "file": "/Users/fallenmax/code/github/taiko/lib/taiko.js" }, "augments": [], "examples": [ { "description": "beforeunload(async () => await accept())\nbeforeunload(async () => await dismiss())\n\n// Note: Taiko's `beforeunload` listener can be setup anywhere in the\n// script. The listener will run when the popup displays on the page." } ], "implements": [], "params": [ { "title": "param", "name": "callback", "lineNumber": 10, "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Action to perform. Accept/Dismiss.", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 35, "offset": 34 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 35, "offset": 34 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 35, "offset": 34 } } }, "type": { "type": "NameExpression", "name": "function" } } ], "properties": [], "returns": [], "sees": [], "throws": [], "todos": [], "yields": [], "name": "beforeunload", "kind": "function", "memberof": "taiko", "scope": "static", "members": { "global": [], "inner": [], "instance": [], "events": [], "static": [] }, "path": [ { "name": "beforeunload", "kind": "function", "scope": "static" } ], "namespace": ".beforeunload" }, { "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Action to perform on dialogs", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 29, "offset": 28 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 29, "offset": 28 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 29, "offset": 28 } } }, "tags": [ { "title": "example", "description": "prompt('Message', async () => await accept('Something'))", "lineNumber": 3 } ], "loc": { "start": { "line": 1122, "column": 0 }, "end": { "line": 1127, "column": 3 } }, "context": { "loc": { "start": { "line": 1128, "column": 0 }, "end": { "line": 1134, "column": 2 } }, "file": "/Users/fallenmax/code/github/taiko/lib/taiko.js" }, "augments": [], "examples": [ { "description": "prompt('Message', async () => await accept('Something'))" } ], "implements": [], "params": [ { "title": "param", "name": "text", "lineNumber": 1128, "default": "''" } ], "properties": [], "returns": [], "sees": [], "throws": [], "todos": [], "yields": [], "name": "accept", "kind": "function", "async": true, "memberof": "taiko", "scope": "static", "members": { "global": [], "inner": [], "instance": [], "events": [], "static": [] }, "path": [ { "name": "accept", "kind": "function", "scope": "static" } ], "namespace": ".accept" }, { "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Action to perform on dialogs", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 29, "offset": 28 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 29, "offset": 28 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 29, "offset": 28 } } }, "tags": [ { "title": "example", "description": "prompt('Message', async () => await dismiss())", "lineNumber": 3 } ], "loc": { "start": { "line": 1135, "column": 0 }, "end": { "line": 1140, "column": 3 } }, "context": { "loc": { "start": { "line": 1141, "column": 0 }, "end": { "line": 1146, "column": 2 } }, "file": "/Users/fallenmax/code/github/taiko/lib/taiko.js" }, "augments": [], "examples": [ { "description": "prompt('Message', async () => await dismiss())" } ], "implements": [], "params": [], "properties": [], "returns": [], "sees": [], "throws": [], "todos": [], "yields": [], "name": "dismiss", "kind": "function", "async": true, "memberof": "taiko", "scope": "static", "members": { "global": [], "inner": [], "instance": [], "events": [], "static": [] }, "path": [ { "name": "dismiss", "kind": "function", "scope": "static" } ], "namespace": ".dismiss" }, { "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Lets you read the global configurations.", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 41, "offset": 40 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 41, "offset": 40 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 41, "offset": 40 } } }, "tags": [ { "title": "example", "description": "getConfig(\"retryInterval\");", "lineNumber": 3 }, { "title": "param", "description": "Specifies the name of the configuration option/paramter you want to get (optional). If not specified, returns a shallow copy of the full global configuration.", "lineNumber": 6, "type": { "type": "NameExpression", "name": "String" }, "name": "optionName" }, { "title": "param", "description": "\"navigationTimeout\"] Navigation timeout value in milliseconds for navigation after performing", "lineNumber": 7, "type": null, "name": "String" }, { "title": "param", "description": "\"observeTime\"] Option to modify delay time in milliseconds for observe mode.", "lineNumber": 8, "type": null, "name": "String" }, { "title": "param", "description": "\"retryInterval\"] Option to modify delay time in milliseconds to retry the search of element existence.", "lineNumber": 9, "type": null, "name": "String" }, { "title": "param", "description": "\"retryTimeout\"] Option to modify timeout in milliseconds while retrying the search of element existence.", "lineNumber": 10, "type": null, "name": "String" }, { "title": "param", "description": "\"observe\"] Option to run each command after a delay. Useful to observe what is happening in the browser.", "lineNumber": 11, "type": null, "name": "String" }, { "title": "param", "description": "\"waitForNavigation\"] Wait for navigation after performing goto, click,\ndoubleClick, rightClick, write, clear,\npress and evaluate.", "lineNumber": 12, "type": null, "name": "String" }, { "title": "param", "description": "\"ignoreSSLErrors\"] Option to ignore SSL errors encountered by the browser.", "lineNumber": 15, "type": null, "name": "String" }, { "title": "param", "description": "\"headful\"] Option to open browser in headless/headful mode.", "lineNumber": 16, "type": null, "name": "String" }, { "title": "param", "description": "\"highlightOnAction\"] Option to highlight an element on action.", "lineNumber": 17, "type": null, "name": "String" } ], "loc": { "start": { "line": 1147, "column": 0 }, "end": { "line": 1165, "column": 3 } }, "context": { "loc": { "start": { "line": 1166, "column": 0 }, "end": { "line": 1166, "column": 37 } }, "file": "/Users/fallenmax/code/github/taiko/lib/taiko.js" }, "augments": [], "examples": [ { "description": "getConfig(\"retryInterval\");" } ], "implements": [], "params": [ { "title": "param", "name": "optionName", "lineNumber": 6, "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Specifies the name of the configuration option/paramter you want to get (optional). If not specified, returns a shallow copy of the full global configuration.", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 159, "offset": 158 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 159, "offset": 158 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 159, "offset": 158 } } }, "type": { "type": "NameExpression", "name": "String" } }, { "title": "param", "name": "String", "lineNumber": 7, "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "\"navigationTimeout\"] Navigation timeout value in milliseconds for navigation after performing", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 94, "offset": 93 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 94, "offset": 93 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 94, "offset": 93 } } } }, { "title": "param", "name": "String", "lineNumber": 8, "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "\"observeTime\"] Option to modify delay time in milliseconds for observe mode.", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 77, "offset": 76 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 77, "offset": 76 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 77, "offset": 76 } } } }, { "title": "param", "name": "String", "lineNumber": 9, "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "\"retryInterval\"] Option to modify delay time in milliseconds to retry the search of element existence.", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 103, "offset": 102 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 103, "offset": 102 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 103, "offset": 102 } } } }, { "title": "param", "name": "String", "lineNumber": 10, "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "\"retryTimeout\"] Option to modify timeout in milliseconds while retrying the search of element existence.", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 105, "offset": 104 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 105, "offset": 104 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 105, "offset": 104 } } } }, { "title": "param", "name": "String", "lineNumber": 11, "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "\"observe\"] Option to run each command after a delay. Useful to observe what is happening in the browser.", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 105, "offset": 104 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 105, "offset": 104 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 105, "offset": 104 } } } }, { "title": "param", "name": "String", "lineNumber": 12, "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "\"waitForNavigation\"] Wait for navigation after performing ", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 59, "offset": 58 }, "indent": [] } }, { "type": "html", "value": "", "position": { "start": { "line": 1, "column": 59, "offset": 58 }, "end": { "line": 1, "column": 75, "offset": 74 }, "indent": [] } }, { "type": "text", "value": "goto", "position": { "start": { "line": 1, "column": 75, "offset": 74 }, "end": { "line": 1, "column": 79, "offset": 78 }, "indent": [] } }, { "type": "html", "value": "", "position": { "start": { "line": 1, "column": 79, "offset": 78 }, "end": { "line": 1, "column": 83, "offset": 82 }, "indent": [] } }, { "type": "text", "value": ", ", "position": { "start": { "line": 1, "column": 83, "offset": 82 }, "end": { "line": 1, "column": 85, "offset": 84 }, "indent": [] } }, { "type": "html", "value": "", "position": { "start": { "line": 1, "column": 85, "offset": 84 }, "end": { "line": 1, "column": 102, "offset": 101 }, "indent": [] } }, { "type": "text", "value": "click", "position": { "start": { "line": 1, "column": 102, "offset": 101 }, "end": { "line": 1, "column": 107, "offset": 106 }, "indent": [] } }, { "type": "html", "value": "", "position": { "start": { "line": 1, "column": 107, "offset": 106 }, "end": { "line": 1, "column": 111, "offset": 110 }, "indent": [] } }, { "type": "text", "value": ",\n", "position": { "start": { "line": 1, "column": 111, "offset": 110 }, "end": { "line": 2, "column": 1, "offset": 112 }, "indent": [ 1 ] } }, { "type": "html", "value": "", "position": { "start": { "line": 2, "column": 1, "offset": 112 }, "end": { "line": 2, "column": 24, "offset": 135 }, "indent": [] } }, { "type": "text", "value": "doubleClick", "position": { "start": { "line": 2, "column": 24, "offset": 135 }, "end": { "line": 2, "column": 35, "offset": 146 }, "indent": [] } }, { "type": "html", "value": "", "position": { "start": { "line": 2, "column": 35, "offset": 146 }, "end": { "line": 2, "column": 39, "offset": 150 }, "indent": [] } }, { "type": "text", "value": ", ", "position": { "start": { "line": 2, "column": 39, "offset": 150 }, "end": { "line": 2, "column": 41, "offset": 152 }, "indent": [] } }, { "type": "html", "value": "", "position": { "start": { "line": 2, "column": 41, "offset": 152 }, "end": { "line": 2, "column": 63, "offset": 174 }, "indent": [] } }, { "type": "text", "value": "rightClick", "position": { "start": { "line": 2, "column": 63, "offset": 174 }, "end": { "line": 2, "column": 73, "offset": 184 }, "indent": [] } }, { "type": "html", "value": "", "position": { "start": { "line": 2, "column": 73, "offset": 184 }, "end": { "line": 2, "column": 77, "offset": 188 }, "indent": [] } }, { "type": "text", "value": ", ", "position": { "start": { "line": 2, "column": 77, "offset": 188 }, "end": { "line": 2, "column": 79, "offset": 190 }, "indent": [] } }, { "type": "html", "value": "", "position": { "start": { "line": 2, "column": 79, "offset": 190 }, "end": { "line": 2, "column": 96, "offset": 207 }, "indent": [] } }, { "type": "text", "value": "write", "position": { "start": { "line": 2, "column": 96, "offset": 207 }, "end": { "line": 2, "column": 101, "offset": 212 }, "indent": [] } }, { "type": "html", "value": "", "position": { "start": { "line": 2, "column": 101, "offset": 212 }, "end": { "line": 2, "column": 105, "offset": 216 }, "indent": [] } }, { "type": "text", "value": ", ", "position": { "start": { "line": 2, "column": 105, "offset": 216 }, "end": { "line": 2, "column": 107, "offset": 218 }, "indent": [] } }, { "type": "html", "value": "", "position": { "start": { "line": 2, "column": 107, "offset": 218 }, "end": { "line": 2, "column": 124, "offset": 235 }, "indent": [] } }, { "type": "text", "value": "clear", "position": { "start": { "line": 2, "column": 124, "offset": 235 }, "end": { "line": 2, "column": 129, "offset": 240 }, "indent": [] } }, { "type": "html", "value": "", "position": { "start": { "line": 2, "column": 129, "offset": 240 }, "end": { "line": 2, "column": 133, "offset": 244 }, "indent": [] } }, { "type": "text", "value": ",\n", "position": { "start": { "line": 2, "column": 133, "offset": 244 }, "end": { "line": 3, "column": 1, "offset": 246 }, "indent": [ 1 ] } }, { "type": "html", "value": "", "position": { "start": { "line": 3, "column": 1, "offset": 246 }, "end": { "line": 3, "column": 18, "offset": 263 }, "indent": [] } }, { "type": "text", "value": "press", "position": { "start": { "line": 3, "column": 18, "offset": 263 }, "end": { "line": 3, "column": 23, "offset": 268 }, "indent": [] } }, { "type": "html", "value": "", "position": { "start": { "line": 3, "column": 23, "offset": 268 }, "end": { "line": 3, "column": 27, "offset": 272 }, "indent": [] } }, { "type": "text", "value": " and ", "position": { "start": { "line": 3, "column": 27, "offset": 272 }, "end": { "line": 3, "column": 32, "offset": 277 }, "indent": [] } }, { "type": "html", "value": "", "position": { "start": { "line": 3, "column": 32, "offset": 277 }, "end": { "line": 3, "column": 52, "offset": 297 }, "indent": [] } }, { "type": "text", "value": "evaluate", "position": { "start": { "line": 3, "column": 52, "offset": 297 }, "end": { "line": 3, "column": 60, "offset": 305 }, "indent": [] } }, { "type": "html", "value": "", "position": { "start": { "line": 3, "column": 60, "offset": 305 }, "end": { "line": 3, "column": 64, "offset": 309 }, "indent": [] } }, { "type": "text", "value": ".", "position": { "start": { "line": 3, "column": 64, "offset": 309 }, "end": { "line": 3, "column": 65, "offset": 310 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 3, "column": 65, "offset": 310 }, "indent": [ 1, 1 ] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 3, "column": 65, "offset": 310 } } } }, { "title": "param", "name": "String", "lineNumber": 15, "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "\"ignoreSSLErrors\"] Option to ignore SSL errors encountered by the browser.", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 75, "offset": 74 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 75, "offset": 74 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 75, "offset": 74 } } } }, { "title": "param", "name": "String", "lineNumber": 16, "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "\"headful\"] Option to open browser in headless/headful mode.", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 60, "offset": 59 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 60, "offset": 59 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 60, "offset": 59 } } } }, { "title": "param", "name": "String", "lineNumber": 17, "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "\"highlightOnAction\"] Option to highlight an element on action.", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 63, "offset": 62 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 63, "offset": 62 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 63, "offset": 62 } } } } ], "properties": [], "returns": [], "sees": [], "throws": [], "todos": [], "yields": [], "name": "getConfig", "memberof": "taiko", "scope": "static", "members": { "global": [], "inner": [], "instance": [], "events": [], "static": [] }, "path": [ { "name": "getConfig", "scope": "static" } ], "namespace": ".getConfig" }, { "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Lets you configure global configurations.", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 42, "offset": 41 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 42, "offset": 41 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 42, "offset": 41 } } }, "tags": [ { "title": "example", "description": "setConfig( { observeTime: 3000});", "lineNumber": 3 }, { "title": "param", "description": null, "lineNumber": 6, "type": { "type": "NameExpression", "name": "Object" }, "name": "options" }, { "title": "param", "description": "Option to modify delay time in milliseconds for observe mode.", "lineNumber": 7, "type": { "type": "OptionalType", "expression": { "type": "NameExpression", "name": "number" } }, "name": "options.observeTime", "default": "3000" }, { "title": "param", "description": "Navigation timeout value in milliseconds for navigation after performing\nopenTab, goto, reload, goBack,\ngoForward, click, write, clear,\npress and evaluate.", "lineNumber": 8, "type": { "type": "OptionalType", "expression": { "type": "NameExpression", "name": "number" } }, "name": "options.navigationTimeout", "default": "30000" }, { "title": "param", "description": "Option to modify delay time in milliseconds to retry the search of element existence.", "lineNumber": 12, "type": { "type": "OptionalType", "expression": { "type": "NameExpression", "name": "number" } }, "name": "options.retryInterval", "default": "100" }, { "title": "param", "description": "Option to modify timeout in milliseconds while retrying the search of element existence.", "lineNumber": 13, "type": { "type": "OptionalType", "expression": { "type": "NameExpression", "name": "number" } }, "name": "options.retryTimeout", "default": "10000" }, { "title": "param", "description": "Wait for navigation after performing goto, click,\ndoubleClick, rightClick, write, clear,\npress and evaluate.", "lineNumber": 14, "type": { "type": "OptionalType", "expression": { "type": "NameExpression", "name": "boolean" } }, "name": "options.waitForNavigation", "default": "true" } ], "loc": { "start": { "line": 1167, "column": 0 }, "end": { "line": 1184, "column": 3 } }, "context": { "loc": { "start": { "line": 1185, "column": 0 }, "end": { "line": 1185, "column": 37 } }, "file": "/Users/fallenmax/code/github/taiko/lib/taiko.js" }, "augments": [], "examples": [ { "description": "setConfig( { observeTime: 3000});" } ], "implements": [], "params": [ { "title": "param", "name": "options", "lineNumber": 6, "type": { "type": "NameExpression", "name": "Object" }, "properties": [ { "title": "param", "name": "options.observeTime", "lineNumber": 7, "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Option to modify delay time in milliseconds for observe mode.", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 62, "offset": 61 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 62, "offset": 61 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 62, "offset": 61 } } }, "type": { "type": "NameExpression", "name": "number" }, "default": "3000" }, { "title": "param", "name": "options.navigationTimeout", "lineNumber": 8, "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Navigation timeout value in milliseconds for navigation after performing\n", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 2, "column": 1, "offset": 73 }, "indent": [ 1 ] } }, { "type": "html", "value": "", "position": { "start": { "line": 2, "column": 1, "offset": 73 }, "end": { "line": 2, "column": 20, "offset": 92 }, "indent": [] } }, { "type": "text", "value": "openTab", "position": { "start": { "line": 2, "column": 20, "offset": 92 }, "end": { "line": 2, "column": 27, "offset": 99 }, "indent": [] } }, { "type": "html", "value": "", "position": { "start": { "line": 2, "column": 27, "offset": 99 }, "end": { "line": 2, "column": 31, "offset": 103 }, "indent": [] } }, { "type": "text", "value": ", ", "position": { "start": { "line": 2, "column": 31, "offset": 103 }, "end": { "line": 2, "column": 33, "offset": 105 }, "indent": [] } }, { "type": "html", "value": "", "position": { "start": { "line": 2, "column": 33, "offset": 105 }, "end": { "line": 2, "column": 49, "offset": 121 }, "indent": [] } }, { "type": "text", "value": "goto", "position": { "start": { "line": 2, "column": 49, "offset": 121 }, "end": { "line": 2, "column": 53, "offset": 125 }, "indent": [] } }, { "type": "html", "value": "", "position": { "start": { "line": 2, "column": 53, "offset": 125 }, "end": { "line": 2, "column": 57, "offset": 129 }, "indent": [] } }, { "type": "text", "value": ", ", "position": { "start": { "line": 2, "column": 57, "offset": 129 }, "end": { "line": 2, "column": 59, "offset": 131 }, "indent": [] } }, { "type": "html", "value": "", "position": { "start": { "line": 2, "column": 59, "offset": 131 }, "end": { "line": 2, "column": 77, "offset": 149 }, "indent": [] } }, { "type": "text", "value": "reload", "position": { "start": { "line": 2, "column": 77, "offset": 149 }, "end": { "line": 2, "column": 83, "offset": 155 }, "indent": [] } }, { "type": "html", "value": "", "position": { "start": { "line": 2, "column": 83, "offset": 155 }, "end": { "line": 2, "column": 87, "offset": 159 }, "indent": [] } }, { "type": "text", "value": ", ", "position": { "start": { "line": 2, "column": 87, "offset": 159 }, "end": { "line": 2, "column": 89, "offset": 161 }, "indent": [] } }, { "type": "html", "value": "", "position": { "start": { "line": 2, "column": 89, "offset": 161 }, "end": { "line": 2, "column": 107, "offset": 179 }, "indent": [] } }, { "type": "text", "value": "goBack", "position": { "start": { "line": 2, "column": 107, "offset": 179 }, "end": { "line": 2, "column": 113, "offset": 185 }, "indent": [] } }, { "type": "html", "value": "", "position": { "start": { "line": 2, "column": 113, "offset": 185 }, "end": { "line": 2, "column": 117, "offset": 189 }, "indent": [] } }, { "type": "text", "value": ",\n", "position": { "start": { "line": 2, "column": 117, "offset": 189 }, "end": { "line": 3, "column": 1, "offset": 191 }, "indent": [ 1 ] } }, { "type": "html", "value": "", "position": { "start": { "line": 3, "column": 1, "offset": 191 }, "end": { "line": 3, "column": 22, "offset": 212 }, "indent": [] } }, { "type": "text", "value": "goForward", "position": { "start": { "line": 3, "column": 22, "offset": 212 }, "end": { "line": 3, "column": 31, "offset": 221 }, "indent": [] } }, { "type": "html", "value": "", "position": { "start": { "line": 3, "column": 31, "offset": 221 }, "end": { "line": 3, "column": 35, "offset": 225 }, "indent": [] } }, { "type": "text", "value": ", ", "position": { "start": { "line": 3, "column": 35, "offset": 225 }, "end": { "line": 3, "column": 37, "offset": 227 }, "indent": [] } }, { "type": "html", "value": "", "position": { "start": { "line": 3, "column": 37, "offset": 227 }, "end": { "line": 3, "column": 54, "offset": 244 }, "indent": [] } }, { "type": "text", "value": "click", "position": { "start": { "line": 3, "column": 54, "offset": 244 }, "end": { "line": 3, "column": 59, "offset": 249 }, "indent": [] } }, { "type": "html", "value": "", "position": { "start": { "line": 3, "column": 59, "offset": 249 }, "end": { "line": 3, "column": 63, "offset": 253 }, "indent": [] } }, { "type": "text", "value": ", ", "position": { "start": { "line": 3, "column": 63, "offset": 253 }, "end": { "line": 3, "column": 65, "offset": 255 }, "indent": [] } }, { "type": "html", "value": "", "position": { "start": { "line": 3, "column": 65, "offset": 255 }, "end": { "line": 3, "column": 82, "offset": 272 }, "indent": [] } }, { "type": "text", "value": "write", "position": { "start": { "line": 3, "column": 82, "offset": 272 }, "end": { "line": 3, "column": 87, "offset": 277 }, "indent": [] } }, { "type": "html", "value": "", "position": { "start": { "line": 3, "column": 87, "offset": 277 }, "end": { "line": 3, "column": 91, "offset": 281 }, "indent": [] } }, { "type": "text", "value": ", ", "position": { "start": { "line": 3, "column": 91, "offset": 281 }, "end": { "line": 3, "column": 93, "offset": 283 }, "indent": [] } }, { "type": "html", "value": "", "position": { "start": { "line": 3, "column": 93, "offset": 283 }, "end": { "line": 3, "column": 110, "offset": 300 }, "indent": [] } }, { "type": "text", "value": "clear", "position": { "start": { "line": 3, "column": 110, "offset": 300 }, "end": { "line": 3, "column": 115, "offset": 305 }, "indent": [] } }, { "type": "html", "value": "", "position": { "start": { "line": 3, "column": 115, "offset": 305 }, "end": { "line": 3, "column": 119, "offset": 309 }, "indent": [] } }, { "type": "text", "value": ",\n", "position": { "start": { "line": 3, "column": 119, "offset": 309 }, "end": { "line": 4, "column": 1, "offset": 311 }, "indent": [ 1 ] } }, { "type": "html", "value": "", "position": { "start": { "line": 4, "column": 1, "offset": 311 }, "end": { "line": 4, "column": 18, "offset": 328 }, "indent": [] } }, { "type": "text", "value": "press", "position": { "start": { "line": 4, "column": 18, "offset": 328 }, "end": { "line": 4, "column": 23, "offset": 333 }, "indent": [] } }, { "type": "html", "value": "", "position": { "start": { "line": 4, "column": 23, "offset": 333 }, "end": { "line": 4, "column": 27, "offset": 337 }, "indent": [] } }, { "type": "text", "value": " and ", "position": { "start": { "line": 4, "column": 27, "offset": 337 }, "end": { "line": 4, "column": 32, "offset": 342 }, "indent": [] } }, { "type": "html", "value": "", "position": { "start": { "line": 4, "column": 32, "offset": 342 }, "end": { "line": 4, "column": 52, "offset": 362 }, "indent": [] } }, { "type": "text", "value": "evaluate", "position": { "start": { "line": 4, "column": 52, "offset": 362 }, "end": { "line": 4, "column": 60, "offset": 370 }, "indent": [] } }, { "type": "html", "value": "", "position": { "start": { "line": 4, "column": 60, "offset": 370 }, "end": { "line": 4, "column": 64, "offset": 374 }, "indent": [] } }, { "type": "text", "value": ".", "position": { "start": { "line": 4, "column": 64, "offset": 374 }, "end": { "line": 4, "column": 65, "offset": 375 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 4, "column": 65, "offset": 375 }, "indent": [ 1, 1, 1 ] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 4, "column": 65, "offset": 375 } } }, "type": { "type": "NameExpression", "name": "number" }, "default": "30000" }, { "title": "param", "name": "options.retryInterval", "lineNumber": 12, "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Option to modify delay time in milliseconds to retry the search of element existence.", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 86, "offset": 85 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 86, "offset": 85 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 86, "offset": 85 } } }, "type": { "type": "NameExpression", "name": "number" }, "default": "100" }, { "title": "param", "name": "options.retryTimeout", "lineNumber": 13, "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Option to modify timeout in milliseconds while retrying the search of element existence.", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 89, "offset": 88 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 89, "offset": 88 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 89, "offset": 88 } } }, "type": { "type": "NameExpression", "name": "number" }, "default": "10000" }, { "title": "param", "name": "options.waitForNavigation", "lineNumber": 14, "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Wait for navigation after performing ", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 38, "offset": 37 }, "indent": [] } }, { "type": "html", "value": "", "position": { "start": { "line": 1, "column": 38, "offset": 37 }, "end": { "line": 1, "column": 54, "offset": 53 }, "indent": [] } }, { "type": "text", "value": "goto", "position": { "start": { "line": 1, "column": 54, "offset": 53 }, "end": { "line": 1, "column": 58, "offset": 57 }, "indent": [] } }, { "type": "html", "value": "", "position": { "start": { "line": 1, "column": 58, "offset": 57 }, "end": { "line": 1, "column": 62, "offset": 61 }, "indent": [] } }, { "type": "text", "value": ", ", "position": { "start": { "line": 1, "column": 62, "offset": 61 }, "end": { "line": 1, "column": 64, "offset": 63 }, "indent": [] } }, { "type": "html", "value": "", "position": { "start": { "line": 1, "column": 64, "offset": 63 }, "end": { "line": 1, "column": 81, "offset": 80 }, "indent": [] } }, { "type": "text", "value": "click", "position": { "start": { "line": 1, "column": 81, "offset": 80 }, "end": { "line": 1, "column": 86, "offset": 85 }, "indent": [] } }, { "type": "html", "value": "", "position": { "start": { "line": 1, "column": 86, "offset": 85 }, "end": { "line": 1, "column": 90, "offset": 89 }, "indent": [] } }, { "type": "text", "value": ",\n", "position": { "start": { "line": 1, "column": 90, "offset": 89 }, "end": { "line": 2, "column": 1, "offset": 91 }, "indent": [ 1 ] } }, { "type": "html", "value": "", "position": { "start": { "line": 2, "column": 1, "offset": 91 }, "end": { "line": 2, "column": 24, "offset": 114 }, "indent": [] } }, { "type": "text", "value": "doubleClick", "position": { "start": { "line": 2, "column": 24, "offset": 114 }, "end": { "line": 2, "column": 35, "offset": 125 }, "indent": [] } }, { "type": "html", "value": "", "position": { "start": { "line": 2, "column": 35, "offset": 125 }, "end": { "line": 2, "column": 39, "offset": 129 }, "indent": [] } }, { "type": "text", "value": ", ", "position": { "start": { "line": 2, "column": 39, "offset": 129 }, "end": { "line": 2, "column": 41, "offset": 131 }, "indent": [] } }, { "type": "html", "value": "", "position": { "start": { "line": 2, "column": 41, "offset": 131 }, "end": { "line": 2, "column": 63, "offset": 153 }, "indent": [] } }, { "type": "text", "value": "rightClick", "position": { "start": { "line": 2, "column": 63, "offset": 153 }, "end": { "line": 2, "column": 73, "offset": 163 }, "indent": [] } }, { "type": "html", "value": "", "position": { "start": { "line": 2, "column": 73, "offset": 163 }, "end": { "line": 2, "column": 77, "offset": 167 }, "indent": [] } }, { "type": "text", "value": ", ", "position": { "start": { "line": 2, "column": 77, "offset": 167 }, "end": { "line": 2, "column": 79, "offset": 169 }, "indent": [] } }, { "type": "html", "value": "", "position": { "start": { "line": 2, "column": 79, "offset": 169 }, "end": { "line": 2, "column": 96, "offset": 186 }, "indent": [] } }, { "type": "text", "value": "write", "position": { "start": { "line": 2, "column": 96, "offset": 186 }, "end": { "line": 2, "column": 101, "offset": 191 }, "indent": [] } }, { "type": "html", "value": "", "position": { "start": { "line": 2, "column": 101, "offset": 191 }, "end": { "line": 2, "column": 105, "offset": 195 }, "indent": [] } }, { "type": "text", "value": ", ", "position": { "start": { "line": 2, "column": 105, "offset": 195 }, "end": { "line": 2, "column": 107, "offset": 197 }, "indent": [] } }, { "type": "html", "value": "", "position": { "start": { "line": 2, "column": 107, "offset": 197 }, "end": { "line": 2, "column": 124, "offset": 214 }, "indent": [] } }, { "type": "text", "value": "clear", "position": { "start": { "line": 2, "column": 124, "offset": 214 }, "end": { "line": 2, "column": 129, "offset": 219 }, "indent": [] } }, { "type": "html", "value": "", "position": { "start": { "line": 2, "column": 129, "offset": 219 }, "end": { "line": 2, "column": 133, "offset": 223 }, "indent": [] } }, { "type": "text", "value": ",\n", "position": { "start": { "line": 2, "column": 133, "offset": 223 }, "end": { "line": 3, "column": 1, "offset": 225 }, "indent": [ 1 ] } }, { "type": "html", "value": "", "position": { "start": { "line": 3, "column": 1, "offset": 225 }, "end": { "line": 3, "column": 18, "offset": 242 }, "indent": [] } }, { "type": "text", "value": "press", "position": { "start": { "line": 3, "column": 18, "offset": 242 }, "end": { "line": 3, "column": 23, "offset": 247 }, "indent": [] } }, { "type": "html", "value": "", "position": { "start": { "line": 3, "column": 23, "offset": 247 }, "end": { "line": 3, "column": 27, "offset": 251 }, "indent": [] } }, { "type": "text", "value": " and ", "position": { "start": { "line": 3, "column": 27, "offset": 251 }, "end": { "line": 3, "column": 32, "offset": 256 }, "indent": [] } }, { "type": "html", "value": "", "position": { "start": { "line": 3, "column": 32, "offset": 256 }, "end": { "line": 3, "column": 52, "offset": 276 }, "indent": [] } }, { "type": "text", "value": "evaluate", "position": { "start": { "line": 3, "column": 52, "offset": 276 }, "end": { "line": 3, "column": 60, "offset": 284 }, "indent": [] } }, { "type": "html", "value": "", "position": { "start": { "line": 3, "column": 60, "offset": 284 }, "end": { "line": 3, "column": 64, "offset": 288 }, "indent": [] } }, { "type": "text", "value": ".", "position": { "start": { "line": 3, "column": 64, "offset": 288 }, "end": { "line": 3, "column": 65, "offset": 289 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 3, "column": 65, "offset": 289 }, "indent": [ 1, 1 ] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 3, "column": 65, "offset": 289 } } }, "type": { "type": "NameExpression", "name": "boolean" }, "default": "true" } ] } ], "properties": [], "returns": [], "sees": [], "throws": [], "todos": [], "yields": [], "name": "setConfig", "memberof": "taiko", "scope": "static", "members": { "global": [], "inner": [], "instance": [], "events": [], "static": [] }, "path": [ { "name": "setConfig", "scope": "static" } ], "namespace": ".setConfig" }, { "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Removes interceptor for the provided URL or all interceptors if no URL is specified", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 84, "offset": 83 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 84, "offset": 83 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 84, "offset": 83 } } }, "tags": [ { "title": "example", "description": "# case 1: Remove intercept for a single URL :\nawait clearIntercept(requestUrl)\n# case 2: Reset intercept for all URL :\nawait clearIntercept()", "lineNumber": 3 }, { "title": "param", "description": "request URL to intercept. Optional parameters", "lineNumber": 9, "type": { "type": "NameExpression", "name": "string" }, "name": "requestUrl" } ], "loc": { "start": { "line": 1225, "column": 0 }, "end": { "line": 1235, "column": 3 } }, "context": { "loc": { "start": { "line": 1236, "column": 0 }, "end": { "line": 1250, "column": 2 } }, "file": "/Users/fallenmax/code/github/taiko/lib/taiko.js" }, "augments": [], "examples": [ { "description": "# case 1: Remove intercept for a single URL :\nawait clearIntercept(requestUrl)\n# case 2: Reset intercept for all URL :\nawait clearIntercept()" } ], "implements": [], "params": [ { "title": "param", "name": "requestUrl", "lineNumber": 9, "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "request URL to intercept. Optional parameters", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 46, "offset": 45 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 46, "offset": 45 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 46, "offset": 45 } } }, "type": { "type": "NameExpression", "name": "string" } } ], "properties": [], "returns": [], "sees": [], "throws": [], "todos": [], "yields": [], "name": "clearIntercept", "kind": "function", "memberof": "taiko", "scope": "static", "members": { "global": [], "inner": [], "instance": [], "events": [], "static": [] }, "path": [ { "name": "clearIntercept", "kind": "function", "scope": "static" } ], "namespace": ".clearIntercept" }, { "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Returns window's current URL.", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 30, "offset": 29 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 30, "offset": 29 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 30, "offset": 29 } } }, "tags": [ { "title": "example", "description": "await openBrowser();\nawait goto(\"www.google.com\");\nawait currentURL(); # returns \"https://www.google.com/?gws_rd=ssl\"", "lineNumber": 2 }, { "title": "returns", "description": "The URL of the current window.", "lineNumber": 7, "type": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Promise" }, "applications": [ { "type": "NameExpression", "name": "string" } ] } } ], "loc": { "start": { "line": 1009, "column": 0 }, "end": { "line": 1017, "column": 3 } }, "context": { "loc": { "start": { "line": 1018, "column": 0 }, "end": { "line": 1022, "column": 2 } }, "file": "/Users/fallenmax/code/github/taiko/lib/taiko.js" }, "augments": [], "examples": [ { "description": "await openBrowser();\nawait goto(\"www.google.com\");\nawait currentURL(); # returns \"https://www.google.com/?gws_rd=ssl\"" } ], "implements": [], "params": [], "properties": [], "returns": [ { "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "The URL of the current window.", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 31, "offset": 30 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 31, "offset": 30 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 31, "offset": 30 } } }, "title": "returns", "type": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Promise" }, "applications": [ { "type": "NameExpression", "name": "string" } ] } } ], "sees": [], "throws": [], "todos": [], "yields": [], "name": "currentURL", "kind": "constant", "members": { "global": [], "inner": [], "instance": [], "events": [], "static": [] }, "path": [ { "name": "currentURL", "kind": "constant" } ], "namespace": "currentURL" }, { "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Copyright 2018 Thoughtworks Inc. All rights reserved.", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 54, "offset": 53 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 54, "offset": 53 }, "indent": [] } }, { "type": "paragraph", "children": [ { "type": "text", "value": "Licensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at", "position": { "start": { "line": 3, "column": 1, "offset": 55 }, "end": { "line": 5, "column": 40, "offset": 223 }, "indent": [ 1, 1 ] } } ], "position": { "start": { "line": 3, "column": 1, "offset": 55 }, "end": { "line": 5, "column": 40, "offset": 223 }, "indent": [ 1, 1 ] } }, { "type": "code", "lang": null, "value": "http://www.apache.org/licenses/LICENSE-2.0", "position": { "start": { "line": 7, "column": 1, "offset": 225 }, "end": { "line": 7, "column": 47, "offset": 271 }, "indent": [] } }, { "type": "paragraph", "children": [ { "type": "text", "value": "Unless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.", "position": { "start": { "line": 9, "column": 1, "offset": 273 }, "end": { "line": 13, "column": 31, "offset": 578 }, "indent": [ 1, 1, 1, 1 ] } } ], "position": { "start": { "line": 9, "column": 1, "offset": 273 }, "end": { "line": 13, "column": 31, "offset": 578 }, "indent": [ 1, 1, 1, 1 ] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 13, "column": 31, "offset": 578 } } }, "tags": [], "loc": { "start": { "line": 2, "column": 0 }, "end": { "line": 16, "column": 3 } }, "context": { "loc": { "start": { "line": 21, "column": 0 }, "end": { "line": 21, "column": 25 } }, "file": "/Users/fallenmax/code/github/taiko/lib/helper.js" }, "augments": [], "examples": [], "implements": [], "params": [], "properties": [], "returns": [], "sees": [], "throws": [], "todos": [], "yields": [], "name": "fs", "kind": "constant", "members": { "global": [], "inner": [], "instance": [], "events": [], "static": [] }, "path": [ { "name": "fs", "kind": "constant" } ], "namespace": "fs" }, { "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "This module is imported from Puppeteer(", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 40, "offset": 39 }, "indent": [] } }, { "type": "link", "title": null, "url": "https://github.com/GoogleChrome/puppeteer", "children": [ { "type": "text", "value": "https://github.com/GoogleChrome/puppeteer", "position": { "start": { "line": 1, "column": 40, "offset": 39 }, "end": { "line": 1, "column": 81, "offset": 80 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 40, "offset": 39 }, "end": { "line": 1, "column": 81, "offset": 80 }, "indent": [] } }, { "type": "text", "value": ")\nFew modifications are done on the file.", "position": { "start": { "line": 1, "column": 81, "offset": 80 }, "end": { "line": 2, "column": 40, "offset": 121 }, "indent": [ 1 ] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 2, "column": 40, "offset": 121 }, "indent": [ 1 ] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 2, "column": 40, "offset": 121 } } }, "tags": [], "loc": { "start": { "line": 17, "column": 0 }, "end": { "line": 20, "column": 3 } }, "context": { "loc": { "start": { "line": 21, "column": 0 }, "end": { "line": 21, "column": 25 } }, "file": "/Users/fallenmax/code/github/taiko/lib/helper.js" }, "augments": [], "examples": [], "implements": [], "params": [], "properties": [], "returns": [], "sees": [], "throws": [], "todos": [], "yields": [], "name": "fs", "kind": "constant", "members": { "global": [], "inner": [], "instance": [], "events": [], "static": [] }, "path": [ { "name": "fs", "kind": "constant" } ], "namespace": "fs" }, { "description": "", "tags": [ { "title": "return", "description": null, "lineNumber": 1, "type": { "type": "NameExpression", "name": "string" } } ], "loc": { "start": { "line": 27, "column": 4 }, "end": { "line": 29, "column": 7 } }, "context": { "loc": { "start": { "line": 30, "column": 4 }, "end": { "line": 37, "column": 5 } }, "file": "/Users/fallenmax/code/github/taiko/lib/helper.js" }, "augments": [], "examples": [], "implements": [], "params": [], "properties": [], "returns": [ { "description": { "type": "root", "children": [], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 1, "offset": 0 } } }, "title": "returns", "type": { "type": "NameExpression", "name": "string" } } ], "sees": [], "throws": [], "todos": [], "yields": [], "name": "projectRoot", "kind": "function", "memberof": "Helper", "scope": "static", "members": { "global": [], "inner": [], "instance": [], "events": [], "static": [] }, "path": [ { "name": "projectRoot", "kind": "function", "scope": "static" } ], "namespace": ".projectRoot" }, { "description": "", "tags": [ { "title": "param", "description": null, "lineNumber": 1, "type": { "type": "AllLiteral" }, "name": "value" }, { "title": "param", "description": null, "lineNumber": 2, "type": { "type": "OptionalType", "expression": { "type": "NameExpression", "name": "string" } }, "name": "message" } ], "loc": { "start": { "line": 66, "column": 0 }, "end": { "line": 69, "column": 3 } }, "context": { "loc": { "start": { "line": 70, "column": 0 }, "end": { "line": 74, "column": 1 } }, "file": "/Users/fallenmax/code/github/taiko/lib/helper.js" }, "augments": [], "examples": [], "implements": [], "params": [ { "title": "param", "name": "value", "lineNumber": 1, "type": { "type": "AllLiteral" } }, { "title": "param", "name": "message", "lineNumber": 2, "type": { "type": "OptionalType", "expression": { "type": "NameExpression", "name": "string" } } } ], "properties": [], "returns": [], "sees": [], "throws": [], "todos": [], "yields": [], "name": "assert", "kind": "function", "members": { "global": [], "inner": [], "instance": [], "events": [], "static": [] }, "path": [ { "name": "assert", "kind": "function" } ], "namespace": "assert" }, { "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Copyright 2018 Thoughtworks Inc. All rights reserved.", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 54, "offset": 53 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 54, "offset": 53 }, "indent": [] } }, { "type": "paragraph", "children": [ { "type": "text", "value": "Licensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at", "position": { "start": { "line": 3, "column": 1, "offset": 55 }, "end": { "line": 5, "column": 40, "offset": 223 }, "indent": [ 1, 1 ] } } ], "position": { "start": { "line": 3, "column": 1, "offset": 55 }, "end": { "line": 5, "column": 40, "offset": 223 }, "indent": [ 1, 1 ] } }, { "type": "code", "lang": null, "value": "http://www.apache.org/licenses/LICENSE-2.0", "position": { "start": { "line": 7, "column": 1, "offset": 225 }, "end": { "line": 7, "column": 47, "offset": 271 }, "indent": [] } }, { "type": "paragraph", "children": [ { "type": "text", "value": "Unless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.", "position": { "start": { "line": 9, "column": 1, "offset": 273 }, "end": { "line": 13, "column": 31, "offset": 578 }, "indent": [ 1, 1, 1, 1 ] } } ], "position": { "start": { "line": 9, "column": 1, "offset": 273 }, "end": { "line": 13, "column": 31, "offset": 578 }, "indent": [ 1, 1, 1, 1 ] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 13, "column": 31, "offset": 578 } } }, "tags": [], "loc": { "start": { "line": 2, "column": 0 }, "end": { "line": 16, "column": 3 } }, "context": { "loc": { "start": { "line": 21, "column": 0 }, "end": { "line": 21, "column": 59 } }, "file": "/Users/fallenmax/code/github/taiko/lib/handlers/inputHandler.js" }, "augments": [], "examples": [], "implements": [], "params": [], "properties": [], "returns": [], "sees": [], "throws": [], "todos": [], "yields": [], "name": "keyDefinitions", "kind": "constant", "members": { "global": [], "inner": [], "instance": [], "events": [], "static": [] }, "path": [ { "name": "keyDefinitions", "kind": "constant" } ], "namespace": "keyDefinitions" }, { "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "This module is imported from Puppeteer(", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 40, "offset": 39 }, "indent": [] } }, { "type": "link", "title": null, "url": "https://github.com/GoogleChrome/puppeteer", "children": [ { "type": "text", "value": "https://github.com/GoogleChrome/puppeteer", "position": { "start": { "line": 1, "column": 40, "offset": 39 }, "end": { "line": 1, "column": 81, "offset": 80 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 40, "offset": 39 }, "end": { "line": 1, "column": 81, "offset": 80 }, "indent": [] } }, { "type": "text", "value": ")\nFew modifications are done on the file.", "position": { "start": { "line": 1, "column": 81, "offset": 80 }, "end": { "line": 2, "column": 40, "offset": 121 }, "indent": [ 1 ] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 2, "column": 40, "offset": 121 }, "indent": [ 1 ] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 2, "column": 40, "offset": 121 } } }, "tags": [], "loc": { "start": { "line": 17, "column": 0 }, "end": { "line": 20, "column": 3 } }, "context": { "loc": { "start": { "line": 21, "column": 0 }, "end": { "line": 21, "column": 59 } }, "file": "/Users/fallenmax/code/github/taiko/lib/handlers/inputHandler.js" }, "augments": [], "examples": [], "implements": [], "params": [], "properties": [], "returns": [], "sees": [], "throws": [], "todos": [], "yields": [], "name": "keyDefinitions", "kind": "constant", "members": { "global": [], "inner": [], "instance": [], "events": [], "static": [] }, "path": [ { "name": "keyDefinitions", "kind": "constant" } ], "namespace": "keyDefinitions" }, { "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Copyright 2018 Thoughtworks Inc. All rights reserved.", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 54, "offset": 53 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 54, "offset": 53 }, "indent": [] } }, { "type": "paragraph", "children": [ { "type": "text", "value": "Licensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at", "position": { "start": { "line": 3, "column": 1, "offset": 55 }, "end": { "line": 5, "column": 40, "offset": 223 }, "indent": [ 1, 1 ] } } ], "position": { "start": { "line": 3, "column": 1, "offset": 55 }, "end": { "line": 5, "column": 40, "offset": 223 }, "indent": [ 1, 1 ] } }, { "type": "code", "lang": null, "value": "http://www.apache.org/licenses/LICENSE-2.0", "position": { "start": { "line": 7, "column": 1, "offset": 225 }, "end": { "line": 7, "column": 47, "offset": 271 }, "indent": [] } }, { "type": "paragraph", "children": [ { "type": "text", "value": "Unless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.", "position": { "start": { "line": 9, "column": 1, "offset": 273 }, "end": { "line": 13, "column": 31, "offset": 578 }, "indent": [ 1, 1, 1, 1 ] } } ], "position": { "start": { "line": 9, "column": 1, "offset": 273 }, "end": { "line": 13, "column": 31, "offset": 578 }, "indent": [ 1, 1, 1, 1 ] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 13, "column": 31, "offset": 578 } } }, "tags": [], "loc": { "start": { "line": 2, "column": 0 }, "end": { "line": 16, "column": 3 } }, "context": { "loc": { "start": { "line": 20, "column": 0 }, "end": { "line": 20, "column": 48 } }, "file": "/Users/fallenmax/code/github/taiko/lib/handlers/domHandler.js" }, "augments": [], "examples": [], "implements": [], "params": [], "properties": [], "returns": [], "sees": [], "throws": [], "todos": [], "yields": [], "name": "require", "kind": "constant", "members": { "global": [], "inner": [], "instance": [], "events": [], "static": [] }, "path": [ { "name": "require", "kind": "constant" } ], "namespace": "require" }, { "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "This module consists of functions imported from Puppeteer(", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 59, "offset": 58 }, "indent": [] } }, { "type": "link", "title": null, "url": "https://github.com/GoogleChrome/puppeteer", "children": [ { "type": "text", "value": "https://github.com/GoogleChrome/puppeteer", "position": { "start": { "line": 1, "column": 59, "offset": 58 }, "end": { "line": 1, "column": 100, "offset": 99 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 59, "offset": 58 }, "end": { "line": 1, "column": 100, "offset": 99 }, "indent": [] } }, { "type": "text", "value": ")", "position": { "start": { "line": 1, "column": 100, "offset": 99 }, "end": { "line": 1, "column": 101, "offset": 100 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 101, "offset": 100 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 101, "offset": 100 } } }, "tags": [], "loc": { "start": { "line": 17, "column": 0 }, "end": { "line": 19, "column": 3 } }, "context": { "loc": { "start": { "line": 20, "column": 0 }, "end": { "line": 20, "column": 48 } }, "file": "/Users/fallenmax/code/github/taiko/lib/handlers/domHandler.js" }, "augments": [], "examples": [], "implements": [], "params": [], "properties": [], "returns": [], "sees": [], "throws": [], "todos": [], "yields": [], "name": "require", "kind": "constant", "members": { "global": [], "inner": [], "instance": [], "events": [], "static": [] }, "path": [ { "name": "require", "kind": "constant" } ], "namespace": "require" }, { "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Copyright 2018 Thoughtworks Inc. All rights reserved.", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 54, "offset": 53 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 54, "offset": 53 }, "indent": [] } }, { "type": "paragraph", "children": [ { "type": "text", "value": "Licensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at", "position": { "start": { "line": 3, "column": 1, "offset": 55 }, "end": { "line": 5, "column": 40, "offset": 223 }, "indent": [ 1, 1 ] } } ], "position": { "start": { "line": 3, "column": 1, "offset": 55 }, "end": { "line": 5, "column": 40, "offset": 223 }, "indent": [ 1, 1 ] } }, { "type": "code", "lang": null, "value": "http://www.apache.org/licenses/LICENSE-2.0", "position": { "start": { "line": 7, "column": 1, "offset": 225 }, "end": { "line": 7, "column": 47, "offset": 271 }, "indent": [] } }, { "type": "paragraph", "children": [ { "type": "text", "value": "Unless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.", "position": { "start": { "line": 9, "column": 1, "offset": 273 }, "end": { "line": 13, "column": 31, "offset": 578 }, "indent": [ 1, 1, 1, 1 ] } } ], "position": { "start": { "line": 9, "column": 1, "offset": 273 }, "end": { "line": 13, "column": 31, "offset": 578 }, "indent": [ 1, 1, 1, 1 ] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 13, "column": 31, "offset": 578 } } }, "tags": [], "loc": { "start": { "line": 2, "column": 0 }, "end": { "line": 16, "column": 3 } }, "context": { "loc": { "start": { "line": 20, "column": 0 }, "end": { "line": 20, "column": 48 } }, "file": "/Users/fallenmax/code/github/taiko/lib/handlers/overlayHandler.js" }, "augments": [], "examples": [], "implements": [], "params": [], "properties": [], "returns": [], "sees": [], "throws": [], "todos": [], "yields": [], "name": "require", "kind": "constant", "members": { "global": [], "inner": [], "instance": [], "events": [], "static": [] }, "path": [ { "name": "require", "kind": "constant" } ], "namespace": "require" }, { "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "This module consists of functions imported from Puppeteer(", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 59, "offset": 58 }, "indent": [] } }, { "type": "link", "title": null, "url": "https://github.com/GoogleChrome/puppeteer", "children": [ { "type": "text", "value": "https://github.com/GoogleChrome/puppeteer", "position": { "start": { "line": 1, "column": 59, "offset": 58 }, "end": { "line": 1, "column": 100, "offset": 99 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 59, "offset": 58 }, "end": { "line": 1, "column": 100, "offset": 99 }, "indent": [] } }, { "type": "text", "value": ")", "position": { "start": { "line": 1, "column": 100, "offset": 99 }, "end": { "line": 1, "column": 101, "offset": 100 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 101, "offset": 100 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 101, "offset": 100 } } }, "tags": [], "loc": { "start": { "line": 17, "column": 0 }, "end": { "line": 19, "column": 3 } }, "context": { "loc": { "start": { "line": 20, "column": 0 }, "end": { "line": 20, "column": 48 } }, "file": "/Users/fallenmax/code/github/taiko/lib/handlers/overlayHandler.js" }, "augments": [], "examples": [], "implements": [], "params": [], "properties": [], "returns": [], "sees": [], "throws": [], "todos": [], "yields": [], "name": "require", "kind": "constant", "members": { "global": [], "inner": [], "instance": [], "events": [], "static": [] }, "path": [ { "name": "require", "kind": "constant" } ], "namespace": "require" }, { "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Copyright 2018 Thoughtworks Inc. All rights reserved.", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 54, "offset": 53 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 54, "offset": 53 }, "indent": [] } }, { "type": "paragraph", "children": [ { "type": "text", "value": "Licensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at", "position": { "start": { "line": 3, "column": 1, "offset": 55 }, "end": { "line": 5, "column": 40, "offset": 223 }, "indent": [ 1, 1 ] } } ], "position": { "start": { "line": 3, "column": 1, "offset": 55 }, "end": { "line": 5, "column": 40, "offset": 223 }, "indent": [ 1, 1 ] } }, { "type": "code", "lang": null, "value": "http://www.apache.org/licenses/LICENSE-2.0", "position": { "start": { "line": 7, "column": 1, "offset": 225 }, "end": { "line": 7, "column": 47, "offset": 271 }, "indent": [] } }, { "type": "paragraph", "children": [ { "type": "text", "value": "Unless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.", "position": { "start": { "line": 9, "column": 1, "offset": 273 }, "end": { "line": 13, "column": 31, "offset": 578 }, "indent": [ 1, 1, 1, 1 ] } } ], "position": { "start": { "line": 9, "column": 1, "offset": 273 }, "end": { "line": 13, "column": 31, "offset": 578 }, "indent": [ 1, 1, 1, 1 ] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 13, "column": 31, "offset": 578 } } }, "tags": [], "loc": { "start": { "line": 2, "column": 0 }, "end": { "line": 16, "column": 3 } }, "context": { "loc": { "start": { "line": 35, "column": 0 }, "end": { "line": 489, "column": 2 } }, "file": "/Users/fallenmax/code/github/taiko/lib/data/USKeyboardLayout.js" }, "augments": [], "examples": [], "implements": [], "params": [], "properties": [], "returns": [], "sees": [], "throws": [], "todos": [], "yields": [], "name": "USKeyboardLayout", "members": { "global": [], "inner": [], "instance": [], "events": [], "static": [] }, "path": [ { "name": "USKeyboardLayout" } ], "namespace": "USKeyboardLayout" }, { "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "This module is imported from Puppeteer(", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 40, "offset": 39 }, "indent": [] } }, { "type": "link", "title": null, "url": "https://github.com/GoogleChrome/puppeteer", "children": [ { "type": "text", "value": "https://github.com/GoogleChrome/puppeteer", "position": { "start": { "line": 1, "column": 40, "offset": 39 }, "end": { "line": 1, "column": 81, "offset": 80 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 40, "offset": 39 }, "end": { "line": 1, "column": 81, "offset": 80 }, "indent": [] } }, { "type": "text", "value": ")\nFew modifications are done on the file.", "position": { "start": { "line": 1, "column": 81, "offset": 80 }, "end": { "line": 2, "column": 40, "offset": 121 }, "indent": [ 1 ] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 2, "column": 40, "offset": 121 }, "indent": [ 1 ] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 2, "column": 40, "offset": 121 } } }, "tags": [], "loc": { "start": { "line": 17, "column": 0 }, "end": { "line": 20, "column": 3 } }, "context": { "loc": { "start": { "line": 35, "column": 0 }, "end": { "line": 489, "column": 2 } }, "file": "/Users/fallenmax/code/github/taiko/lib/data/USKeyboardLayout.js" }, "augments": [], "examples": [], "implements": [], "params": [], "properties": [], "returns": [], "sees": [], "throws": [], "todos": [], "yields": [], "name": "USKeyboardLayout", "members": { "global": [], "inner": [], "instance": [], "events": [], "static": [] }, "path": [ { "name": "USKeyboardLayout" } ], "namespace": "USKeyboardLayout" }, { "description": "", "tags": [ { "title": "type", "description": null, "lineNumber": 1, "type": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Object" }, "applications": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "KeyDefinition" } ] } } ], "loc": { "start": { "line": 32, "column": 0 }, "end": { "line": 34, "column": 3 } }, "context": { "loc": { "start": { "line": 35, "column": 0 }, "end": { "line": 489, "column": 2 } }, "file": "/Users/fallenmax/code/github/taiko/lib/data/USKeyboardLayout.js" }, "augments": [], "examples": [], "implements": [], "params": [], "properties": [], "returns": [], "sees": [], "throws": [], "todos": [], "yields": [], "type": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Object" }, "applications": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "KeyDefinition" } ] }, "name": "USKeyboardLayout", "members": { "global": [], "inner": [], "instance": [], "events": [], "static": [] }, "path": [ { "name": "USKeyboardLayout" } ], "namespace": "USKeyboardLayout" }, { "description": "", "tags": [ { "title": "typedef", "description": null, "lineNumber": 1, "type": { "type": "NameExpression", "name": "Object" }, "name": "KeyDefinition" }, { "title": "property", "description": null, "lineNumber": 2, "type": { "type": "OptionalType", "expression": { "type": "NameExpression", "name": "number" } }, "name": "keyCode" }, { "title": "property", "description": null, "lineNumber": 3, "type": { "type": "OptionalType", "expression": { "type": "NameExpression", "name": "number" } }, "name": "shiftKeyCode" }, { "title": "property", "description": null, "lineNumber": 4, "type": { "type": "OptionalType", "expression": { "type": "NameExpression", "name": "string" } }, "name": "key" }, { "title": "property", "description": null, "lineNumber": 5, "type": { "type": "OptionalType", "expression": { "type": "NameExpression", "name": "string" } }, "name": "shiftKey" }, { "title": "property", "description": null, "lineNumber": 6, "type": { "type": "OptionalType", "expression": { "type": "NameExpression", "name": "string" } }, "name": "code" }, { "title": "property", "description": null, "lineNumber": 7, "type": { "type": "OptionalType", "expression": { "type": "NameExpression", "name": "string" } }, "name": "text" }, { "title": "property", "description": null, "lineNumber": 8, "type": { "type": "OptionalType", "expression": { "type": "NameExpression", "name": "string" } }, "name": "shiftText" }, { "title": "property", "description": null, "lineNumber": 9, "type": { "type": "OptionalType", "expression": { "type": "NameExpression", "name": "number" } }, "name": "location" } ], "loc": { "start": { "line": 21, "column": 0 }, "end": { "line": 31, "column": 3 } }, "context": { "loc": { "start": { "line": 35, "column": 0 }, "end": { "line": 489, "column": 2 } }, "file": "/Users/fallenmax/code/github/taiko/lib/data/USKeyboardLayout.js" }, "augments": [], "examples": [], "implements": [], "params": [], "properties": [ { "title": "property", "name": "keyCode", "lineNumber": 2, "type": { "type": "OptionalType", "expression": { "type": "NameExpression", "name": "number" } } }, { "title": "property", "name": "shiftKeyCode", "lineNumber": 3, "type": { "type": "OptionalType", "expression": { "type": "NameExpression", "name": "number" } } }, { "title": "property", "name": "key", "lineNumber": 4, "type": { "type": "OptionalType", "expression": { "type": "NameExpression", "name": "string" } } }, { "title": "property", "name": "shiftKey", "lineNumber": 5, "type": { "type": "OptionalType", "expression": { "type": "NameExpression", "name": "string" } } }, { "title": "property", "name": "code", "lineNumber": 6, "type": { "type": "OptionalType", "expression": { "type": "NameExpression", "name": "string" } } }, { "title": "property", "name": "text", "lineNumber": 7, "type": { "type": "OptionalType", "expression": { "type": "NameExpression", "name": "string" } } }, { "title": "property", "name": "shiftText", "lineNumber": 8, "type": { "type": "OptionalType", "expression": { "type": "NameExpression", "name": "string" } } }, { "title": "property", "name": "location", "lineNumber": 9, "type": { "type": "OptionalType", "expression": { "type": "NameExpression", "name": "number" } } } ], "returns": [], "sees": [], "throws": [], "todos": [], "yields": [], "kind": "typedef", "name": "KeyDefinition", "type": { "type": "NameExpression", "name": "Object" }, "members": { "global": [], "inner": [], "instance": [], "events": [], "static": [] }, "path": [ { "name": "KeyDefinition", "kind": "typedef" } ], "namespace": "KeyDefinition" }, { "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "创建一个函数装饰器", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 10, "offset": 9 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 10, "offset": 9 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 10, "offset": 9 } } }, "tags": [], "loc": { "start": { "line": 6, "column": 0 }, "end": { "line": 6, "column": 16 } }, "context": { "loc": { "start": { "line": 7, "column": 0 }, "end": { "line": 47, "column": 1 } }, "file": "/Users/fallenmax/code/github/taiko/lib/ts/util/decorators.js" }, "augments": [], "examples": [], "implements": [], "params": [ { "title": "param", "name": "$0", "anonymous": true, "type": { "type": "NameExpression", "name": "Object" }, "properties": [ { "title": "param", "name": "$0.onCalled", "lineNumber": 7 }, { "title": "param", "name": "$0.onReturned", "lineNumber": 7 }, { "title": "param", "name": "$0.onError", "lineNumber": 7 }, { "title": "param", "name": "$0.self", "lineNumber": 7, "default": "null" } ] } ], "properties": [], "returns": [], "sees": [], "throws": [], "todos": [], "yields": [], "name": "createDecorator", "kind": "function", "members": { "global": [], "inner": [], "instance": [], "events": [], "static": [] }, "path": [ { "name": "createDecorator", "kind": "function" } ], "namespace": "createDecorator" }, { "description": "", "tags": [ { "title": "param", "description": null, "lineNumber": 1, "type": { "type": "NameExpression", "name": "string" }, "name": "line" } ], "loc": { "start": { "line": 32, "column": 12 }, "end": { "line": 34, "column": 15 } }, "context": { "loc": { "start": { "line": 35, "column": 12 }, "end": { "line": 48, "column": 13 } }, "file": "/Users/fallenmax/code/github/taiko/lib/browserFetcher.js" }, "augments": [], "examples": [], "implements": [], "params": [ { "title": "param", "name": "line", "lineNumber": 1, "type": { "type": "NameExpression", "name": "string" } } ], "properties": [], "returns": [], "sees": [], "throws": [], "todos": [], "yields": [], "name": "onLine", "kind": "function", "members": { "global": [], "inner": [], "instance": [], "events": [], "static": [] }, "path": [ { "name": "onLine", "kind": "function" } ], "namespace": "onLine" }, { "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Copyright 2018 Thoughtworks Inc. All rights reserved.", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 54, "offset": 53 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 54, "offset": 53 }, "indent": [] } }, { "type": "paragraph", "children": [ { "type": "text", "value": "Licensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at", "position": { "start": { "line": 3, "column": 1, "offset": 55 }, "end": { "line": 5, "column": 40, "offset": 223 }, "indent": [ 1, 1 ] } } ], "position": { "start": { "line": 3, "column": 1, "offset": 55 }, "end": { "line": 5, "column": 40, "offset": 223 }, "indent": [ 1, 1 ] } }, { "type": "code", "lang": null, "value": "http://www.apache.org/licenses/LICENSE-2.0", "position": { "start": { "line": 7, "column": 1, "offset": 225 }, "end": { "line": 7, "column": 47, "offset": 271 }, "indent": [] } }, { "type": "paragraph", "children": [ { "type": "text", "value": "Unless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.", "position": { "start": { "line": 9, "column": 1, "offset": 273 }, "end": { "line": 13, "column": 31, "offset": 578 }, "indent": [ 1, 1, 1, 1 ] } } ], "position": { "start": { "line": 9, "column": 1, "offset": 273 }, "end": { "line": 13, "column": 31, "offset": 578 }, "indent": [ 1, 1, 1, 1 ] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 13, "column": 31, "offset": 578 } } }, "tags": [], "loc": { "start": { "line": 2, "column": 0 }, "end": { "line": 16, "column": 3 } }, "context": { "loc": { "start": { "line": 21, "column": 0 }, "end": { "line": 759, "column": 2 } }, "file": "/Users/fallenmax/code/github/taiko/lib/data/devices.js" }, "augments": [], "examples": [], "implements": [], "params": [], "properties": [], "returns": [], "sees": [], "throws": [], "todos": [], "yields": [], "name": "DEVICES", "members": { "global": [], "inner": [], "instance": [], "events": [], "static": [] }, "path": [ { "name": "DEVICES" } ], "namespace": "DEVICES" }, { "description": { "type": "root", "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "This module is imported from Puppeteer(", "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 1, "column": 40, "offset": 39 }, "indent": [] } }, { "type": "link", "title": null, "url": "https://github.com/GoogleChrome/puppeteer", "children": [ { "type": "text", "value": "https://github.com/GoogleChrome/puppeteer", "position": { "start": { "line": 1, "column": 40, "offset": 39 }, "end": { "line": 1, "column": 81, "offset": 80 }, "indent": [] } } ], "position": { "start": { "line": 1, "column": 40, "offset": 39 }, "end": { "line": 1, "column": 81, "offset": 80 }, "indent": [] } }, { "type": "text", "value": ")\nFew modifications are done on the file.", "position": { "start": { "line": 1, "column": 81, "offset": 80 }, "end": { "line": 2, "column": 40, "offset": 121 }, "indent": [ 1 ] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 2, "column": 40, "offset": 121 }, "indent": [ 1 ] } } ], "position": { "start": { "line": 1, "column": 1, "offset": 0 }, "end": { "line": 2, "column": 40, "offset": 121 } } }, "tags": [], "loc": { "start": { "line": 17, "column": 0 }, "end": { "line": 20, "column": 3 } }, "context": { "loc": { "start": { "line": 21, "column": 0 }, "end": { "line": 759, "column": 2 } }, "file": "/Users/fallenmax/code/github/taiko/lib/data/devices.js" }, "augments": [], "examples": [], "implements": [], "params": [], "properties": [], "returns": [], "sees": [], "throws": [], "todos": [], "yields": [], "name": "DEVICES", "members": { "global": [], "inner": [], "instance": [], "events": [], "static": [] }, "path": [ { "name": "DEVICES" } ], "namespace": "DEVICES" } ]