{"id":20591432,"url":"https://github.com/airtap/sauce","last_synced_at":"2026-05-08T03:05:20.927Z","repository":{"id":42522048,"uuid":"289661545","full_name":"airtap/sauce","owner":"airtap","description":"Sauce Labs browser provider.","archived":false,"fork":false,"pushed_at":"2023-11-01T14:07:28.000Z","size":20,"stargazers_count":0,"open_issues_count":3,"forks_count":1,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-02-18T05:37:52.684Z","etag":null,"topics":["airtap","browsers","javascript","nodejs","npm-package","sauce-labs"],"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/airtap.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-08-23T10:14:34.000Z","updated_at":"2024-05-17T16:50:50.000Z","dependencies_parsed_at":"2024-06-20T23:29:23.741Z","dependency_job_id":"756dff59-f2bb-4409-9df9-2502ba91e4ed","html_url":"https://github.com/airtap/sauce","commit_stats":{"total_commits":21,"total_committers":3,"mean_commits":7.0,"dds":"0.33333333333333337","last_synced_commit":"5854e355f0669871df2a273e63eddb3228b21ac0"},"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/airtap%2Fsauce","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/airtap%2Fsauce/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/airtap%2Fsauce/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/airtap%2Fsauce/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/airtap","download_url":"https://codeload.github.com/airtap/sauce/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":242223015,"owners_count":20092171,"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":["airtap","browsers","javascript","nodejs","npm-package","sauce-labs"],"created_at":"2024-11-16T07:40:18.690Z","updated_at":"2026-05-08T03:05:20.869Z","avatar_url":"https://github.com/airtap.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# airtap-sauce\n\n**Sauce Labs [browser provider](https://github.com/airtap/browser-provider). List and run browsers on [Sauce Labs](https://saucelabs.com/).**\n\n[![npm status](http://img.shields.io/npm/v/airtap-sauce.svg)](https://www.npmjs.org/package/airtap-sauce)\n[![node](https://img.shields.io/node/v/airtap-sauce.svg)](https://www.npmjs.org/package/airtap-sauce)\n[![Sauce Labs integration status](https://github.com/airtap/sauce/workflows/Sauce%20Labs/badge.svg)](https://github.com/airtap/sauce/actions?query=workflow%3A%22Sauce+Labs%22)\n[![Lint](https://github.com/airtap/sauce/workflows/Lint/badge.svg)](https://github.com/airtap/sauce/actions?query=workflow%3ALint)\n[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)\n\n## Table of Contents\n\n\u003cdetails\u003e\u003csummary\u003eClick to expand\u003c/summary\u003e\n\n- [Usage](#usage)\n  - [Programmatic](#programmatic)\n  - [With Airtap](#with-airtap)\n- [API](#api)\n  - [`Sauce([options])`](#sauceoptions)\n  - [Browser options](#browser-options)\n- [Install](#install)\n- [Big Thanks](#big-thanks)\n- [License](#license)\n\n\u003c/details\u003e\n\n## Usage\n\n### Programmatic\n\n```js\nconst Sauce = require('airtap-sauce')\nconst provider = new Sauce()\n\n// Get a list of desired browsers\nconst wanted = [{ name: 'android', version: '5..latest' }]\nconst manifests = await provider.manifests(wanted)\n\n// Instantiate a browser\nconst target = { url: 'http://localhost:3000' }\nconst browser = provider.browser(manifests[0], target)\n\nawait browser.open()\n```\n\n### With [Airtap](https://github.com/airtap/airtap)\n\n```yaml\nproviders:\n  - airtap-sauce\n\nbrowsers:\n  - name: android\n    version: 5..latest\n```\n\nThis provider also exposes `platform`, `capabilities` and [more properties](https://github.com/airtap/sauce-browsers) to match on:\n\n```yaml\nbrowsers:\n  - name: chrome\n    version: 69\n    platform: mac 10.15\n```\n\n## API\n\n### `Sauce([options])`\n\nConstructor. Returns an instance of [`browser-provider`](https://github.com/airtap/browser-provider). Options:\n\n- `username` (string): defaults to `process.env.SAUCE_USERNAME`\n- `key` (string): defaults to `process.env.SAUCE_ACCESS_KEY`\n- `hostname` (string): defaults to `'ondemand.saucelabs.com'`\n- `port` (number): defaults to `80`\n- `tunnel` (object): custom options for [`sauce-connect-launcher`](https://github.com/bermi/sauce-connect-launcher)\n\nIn Airtap these can be set like so:\n\n```yaml\nproviders:\n  - airtap-sauce:\n      tunnel:\n        connectRetries: 10\n```\n\n### Browser options\n\n- `name` (string): name for Sauce Labs job, defaults to browser manifest name\n- `profile` (object, only on Firefox): custom user profile to programmatically configure anything that can be changed in `about:config`\n- `capabilities` (object): custom Selenium capabilities.\n\nIn Airtap these can be set like so:\n\n```yaml\nbrowsers:\n  - name: firefox\n    options:\n      name: my-custom-job-name\n      profile:\n        webgl.force-enabled: true\n```\n\n## Install\n\nWith [npm](https://npmjs.org) do:\n\n```\nnpm install airtap-sauce\n```\n\n## Big Thanks\n\nCross-browser Testing Platform and Open Source ♥ Provided by [Sauce Labs](https://saucelabs.com).\n\n[![Sauce Labs logo](./sauce-labs.svg)](https://saucelabs.com)\n\n## License\n\n[MIT](LICENSE) © 2018 [Roman Shtylman](https://github.com/defunctzombie), [Zuul contributors](https://github.com/defunctzombie/zuul/graphs/contributors) and [Airtap contributors](https://github.com/airtap)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fairtap%2Fsauce","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fairtap%2Fsauce","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fairtap%2Fsauce/lists"}