{"id":15043970,"url":"https://github.com/alekseykulikov/sweb","last_synced_at":"2025-10-23T15:30:30.912Z","repository":{"id":57376017,"uuid":"75701453","full_name":"alekseykulikov/sweb","owner":"alekseykulikov","description":"High-level abstraction for selenium-webdriver","archived":false,"fork":false,"pushed_at":"2016-12-20T07:00:18.000Z","size":94,"stargazers_count":4,"open_issues_count":0,"forks_count":1,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-01-30T19:11:19.191Z","etag":null,"topics":["e2e","selenium-webdriver","testing"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/alekseykulikov.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-12-06T06:24:33.000Z","updated_at":"2016-12-20T06:40:08.000Z","dependencies_parsed_at":"2022-09-02T19:32:09.593Z","dependency_job_id":null,"html_url":"https://github.com/alekseykulikov/sweb","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alekseykulikov%2Fsweb","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alekseykulikov%2Fsweb/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alekseykulikov%2Fsweb/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alekseykulikov%2Fsweb/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/alekseykulikov","download_url":"https://codeload.github.com/alekseykulikov/sweb/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":237843854,"owners_count":19375216,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["e2e","selenium-webdriver","testing"],"created_at":"2024-09-24T20:49:53.758Z","updated_at":"2025-10-23T15:30:30.551Z","avatar_url":"https://github.com/alekseykulikov.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# sweb [![](https://circleci.com/gh/alekseykulikov/sweb.svg?style=svg)](https://circleci.com/gh/alekseykulikov/sweb)\n\n\u003e High-level abstraction for selenium-webdriver\n\n**Features**:\n- Built with [Selenium v3](https://seleniumhq.wordpress.com/2016/10/13/selenium-3-0-out-now/) and [W3C WebDriver](https://www.w3.org/TR/webdriver/)\n- Supports DOM API to explore page structure (via [jsdom](https://github.com/tmpvar/jsdom))\n- No setup: built in Chrome support (via [chromedriver](https://github.com/giggio/node-chromedriver))\n- Flexibility: integrates with any test framework, node script, and selenium cloud provider.\n\n## Example\n\nSmoke test for http://example.com\nusing [mocha](https://mochajs.org/) and [chai](http://chaijs.com/).\n\n```js\nimport { expect } from 'chai'\nimport { Browser } from 'sweb'\n\ndescribe('smoke-tests', () =\u003e {\n  let browser\n  before(() =\u003e { browser = new Browser() })\n  after(() =\u003e { browser.quit() })\n\n  it('opens example.com', async () =\u003e {\n    const page = await browser.open('example.com')\n    expect(page.url).equal('http://example.com/')\n    expect(page.title).equal('Example Domain')\n    expect(page.document.links).length(1)\n    expect(page.document.querySelector('a').href).equal('http://www.iana.org/domains/example')\n    await page.click('a')\n    expect(page.url).equal('http://www.iana.org/domains/reserved')\n  })\n})\n```\n\n## Installation\n\n[![](https://img.shields.io/npm/v/sweb.svg)](https://npmjs.org/package/sweb)\n[![](http://img.shields.io/npm/dm/sweb.svg)](https://npmjs.org/package/sweb)\n\nRequires node \u003e= 6.9 (because of [selenium-webdriver](https://www.npmjs.com/package/selenium-webdriver#projected-support-schedule))\n\n    $ yarn add -D sweb\n    $ npm i -D sweb\n\n## API\n\n### new Browser(opts = {})\n\nCreates new `Browser` instance.\n\nAvailable options:\n- `screenhostOnError` (default: false) - make automatic screenshot when `sweb` throws a custom error, for example on failed waitFor or click.\n- `workDir` (default: `${cwd}/.sweb`) - specify directory for sweb's logs and screenshots. If folder does not exist, it will be created automatically.\n- `driver` - custom build of WebDriver, useful for running different browsers or for Browserstack/Saucelabs integration. Check [custom drivers](#custom-drivers) section for more details.\n\n### await browser.open(url)\n\nLoad `url` in browser and return `Page` instance.\n\n`Page` instance has useful properties:\n- `url` - page url\n- `document` - similar to `window.document`, it's a [jsdom](https://github.com/tmpvar/jsdom) instance with support of all DOM API methods.\n- `title` - page title\n- `source` - page html source\n- `driver` - [WebDriver instance](http://seleniumhq.github.io/selenium/docs/api/javascript/module/selenium-webdriver/lib/webdriver_exports_WebDriver.html)\n\n### await browser.quit()\n\nQuit real browser.\n\n### await page.click(selector)\n\nPerform click event to `selector`.\n\n### await page.type(selector, text)\n\nSend user type input (combination of keydown, keypress, keyup for each character) to `selector` with `text`.\nTo emulate special keys like ENTER or F12 use [`Key`](http://seleniumhq.github.io/selenium/docs/api/javascript/module/selenium-webdriver/index_exports_Key.html).\n\n```js\nimport { Browser, Key } from 'sweb'\n\nconst browser = new Browser()\nconst page = await browser.open('https://www.google.com')\nawait page.type('[name=\"q\"]', `selenium webdriver npm${Key.ENTER}`)\n```\n\n### await page.waitFor(selector, delay = 2000)\n\nWait for `selector` appears in html.\n\n### await page.screenshot(name)\n\nMake screenshot of the page and store to `${browser.workDir}/${name}.png`.\n\n## Custom drivers\n\n`driver` option allows to pass custom `selenium-webdriver` configuration.\n\n### Firefox with geckodriver\n\n```js\nimport 'geckodriver'\nimport { Browser, Builder } from 'sweb'\n\nconst driver = new Builder().forBrowser('firefox').build()\nconst browser = new Browser({ driver })\nconst page = await browser.open('http://example.com')\n```\n\n### Integration with Browserstack\n\n```js\nimport { Browser, Builder } from 'sweb'\n\nconst driver = new Builder()\n  .usingServer('http://hub-cloud.browserstack.com/wd/hub')\n  .withCapabilities({\n    'browserName': 'chrome',\n    'browserstack.user': browserStackUser,\n    'browserstack.key': browserStackKey,\n    'browserstack.debug': 'true',\n    'build': 'First build'\n  })\n  .build()\n\nconst browser = new Browser({ driver })\nconst page = await browser.open('https://www.google.com')  \n```\n\n### Integration with Saucelabs\n\n```js\nimport { Browser, Builder } from 'sweb'\n\nconst driver = new Builder()\n  .usingServer('http://' + username + ':' + accessKey + '@ondemand.saucelabs.com:80/wd/hub')\n  .withCapabilities({\n    'browserName': 'chrome',\n    'platform': 'Windows XP',\n    'version': '43.0',\n    username,\n    accessKey\n  })\n  .build()\n\nconst browser = new Browser({ driver })\nconst page = await browser.open('http://example.com')\n```\n\n## LICENSE\n\n[MIT](./LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falekseykulikov%2Fsweb","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Falekseykulikov%2Fsweb","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falekseykulikov%2Fsweb/lists"}