# sauce-results

> Set test results for a Sauce Labs job

Latest version **0.1.0** (published 2013-12-10) · BSD license · 0 weekly downloads

## Install

```sh
npm install sauce-results
pnpm add sauce-results
yarn add sauce-results
bun add sauce-results
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.0 |
| Published | 2013-12-10 |
| First published | 2013-10-02 |
| Weekly downloads | 0 |
| License | BSD |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 (+2 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Conrad Zimmerman |
| Maintainers | conradz |
| Keywords | sauce, sauce-labs, tap, test, testing |

## Links

- npm: https://www.npmjs.com/package/sauce-results
- Repository: https://github.com/conradz/sauce-results
- Issues: https://github.com/conradz/sauce-results/issues
- npm.io page: https://npm.io/package/sauce-results

## Dependencies (1)

- [request](https://npm.io/package/request.md) ~2.29.0

## Alternatives

- [duck](https://npm.io/package/duck.md) — 4.2M weekly downloads
- [ava](https://npm.io/package/ava.md) — 560.2K weekly downloads
- [storybook-addon-module-mock](https://npm.io/package/storybook-addon-module-mock.md) — 71.7K weekly downloads
- [vest](https://npm.io/package/vest.md) — 50.1K weekly downloads
- [@ethereum-waffle/mock-contract](https://npm.io/package/@ethereum-waffle/mock-contract.md) — 40.0K weekly downloads

## Recent versions

- 0.1.0 (latest) — 2013-12-10
- 0.0.1 — 2013-10-02
- 0.0.0 — 2013-10-02

## README

# sauce-results

[![NPM](https://nodei.co/npm/sauce-results.png)](https://nodei.co/npm/sauce-results/)

[![Build Status](https://drone.io/github.com/conradz/sauce-results/status.png)](https://drone.io/github.com/conradz/sauce-results/latest)
[![Dependency Status](https://gemnasium.com/conradz/sauce-results.png)](https://gemnasium.com/conradz/sauce-results)

Helper to publish the results of a [Sauce Labs](https://saucelabs.com/) test
job. Then you can use the awesome
[status images](https://saucelabs.com/docs/status-images).

Example status image:

[![Selenium Test Status](https://saucelabs.com/browser-matrix/sauce-results-test.svg)](https://saucelabs.com/u/sauce-results-test)

Simply call the function with the options object and a callback function.

## Example

```js
var results = require('sauce-results');

results({
    user: sauceUser,
    key: sauceKey,
    job: sauceJobId,
    passed: true
}, function(err) {
    // Handle err if it exists
});
```

## Options

 * `user`: The Sauce Labs username for the tests
 * `key`: The Sauce Labs key for the provided user
 * `job`: The Sauce Labs job ID. If none is provided, it will retrieve the last job ID.
 * `passed`: Boolean indicating if the job passed or not

## Credits

Thanks goes to @rvagg for doing something like this in
[brtapsauce](https://github.com/rvagg/brtapsauce). This module was split out
from the larger project and rewritten based on his code.

---
_Source: https://npm.io/package/sauce-results · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._