Skip to content

Commit

Permalink
Use README.md as home for docs site
Browse files Browse the repository at this point in the history
  • Loading branch information
@shirish87
shirish87 committed Jan 30, 2024
1 parent d7293bd commit 4e4ef9c
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 319 deletions.
6 changes: 6 additions & 0 deletions .github/workflows/docs.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,11 @@ on:
# - '*'
workflow_dispatch:

# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
group: pages
cancel-in-progress: false

jobs:
build-docs:
Expand All @@ -22,6 +27,7 @@ jobs:
node-version: "lts/*"
cache: "npm"
- run: |
cp README.md docs/index.md
npm install
npm run prebuild
npm run docs:build
Expand Down
332 changes: 13 additions & 319 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
home: true
---

# BrowserStack Client

This module interfaces all REST APIs offered by [BrowserStack](https://www.browserstack.com).
Expand All @@ -14,7 +18,7 @@ $ npm i --save browserstack-client

Please ensure that your BrowserStack account contains the required subscription(s) for using the APIs provided by this module.

Add your BrowserStack username and API key for Automate/JavaScript testing to the following environment variables for your shell.
Add your BrowserStack username and API key to the following environment variables for your shell.

You may also supply these credentials in code when creating an instance of an API client. See `options.username` and `options.key`.
```
Expand All @@ -26,331 +30,21 @@ BROWSERSTACK_KEY=<your-access-key>
## Usage

```
var BrowserStack = require('browserstack-client');
import { BrowserStack } from 'browserstack-client';
// BrowserStack JavaScript Testing API
var apiClient = new BrowserStack.Client();
const apiClient = new BrowserStack.Client();
// BrowserStack Automate API
var automateClient = new BrowserStack.AutomateClient();
// BrowserStack Screenshots API
var screenshotsClient = new BrowserStack.ScreenshotsClient();
```


All method calls return a [Bluebird](https://github.com/petkaantonov/bluebird) promise and also take an optional callback parameter.

```
// Using Bluebird Promise
apiClient
.getStatus()
.then(function (status) {
console.log('Status', status);
})
.catch(function (e) {
console.error(e);
});
// Using node-convention callbacks
apiClient.getStatus(function (err, status) {
if (err) { return console.error(err); }
const automateClient = new BrowserStack.AutomateClient();
console.log('Status', status);
});
// BrowserStack App Automate API
const appAutomateClient = new BrowserStack.AppAutomateClient();
// BrowserStack Screenshots API
const screenshotsClient = new BrowserStack.ScreenshotsClient();
```

Please refer to the documentation below for methods available for each of these clients.

* * *

## Documentation

<dl>
<dt><a href="#APIClient">APIClient</a></dt>
<dd><p>Create and manage workers for automated JavaScript testing.</p>
</dd>
<dt><a href="#AutomateClient">AutomateClient</a></dt>
<dd><p>Access and manage information about your BrowserStack Automate tests.</p>
</dd>
<dt><a href="#ScreenshotsClient">ScreenshotsClient</a></dt>
<dd><p>Create and manage Screenshot jobs running under the BrowserStack Screenshots API.</p>
</dd>
<dt><a href="#BrowserStackTunnel">BrowserStackTunnel</a></dt>
<dd><p>Downloads and manages the BrowserStackLocal binary.</p>
</dd>
</dl>


ERROR, Cannot find class.

<a name="AutomateClient"></a>
## AutomateClient
Access and manage information about your BrowserStack Automate tests.

**Kind**: global class
**Access:** public
**Version**: v1

* [AutomateClient](#AutomateClient)
* [new AutomateClient(options)](#new_AutomateClient_new)
* [.getBrowsers(callback)](#AutomateClient+getBrowsers) ⇒ <code>Promise</code>
* [.getStatus(callback)](#AutomateClient+getStatus) ⇒ <code>Promise</code>
* [.getProjects(callback)](#AutomateClient+getProjects) ⇒ <code>Promise</code>
* [.getProject(projectId, callback)](#AutomateClient+getProject) ⇒ <code>Promise</code>
* [.getBuilds(options, callback)](#AutomateClient+getBuilds) ⇒ <code>Promise</code>
* [.getBuildSessions(buildId, options, callback)](#AutomateClient+getBuildSessions) ⇒ <code>Promise</code>
* [.getSession(sessionId, callback)](#AutomateClient+getSession) ⇒ <code>Promise</code>
* [.setStatus(sessionId, data, callback)](#AutomateClient+setStatus) ⇒ <code>Promise</code>
* [.getSessionLogs(sessionId, callback)](#AutomateClient+getSessionLogs) ⇒ <code>Promise</code>
* [.recycleKey(callback)](#AutomateClient+recycleKey) ⇒ <code>Promise</code>

<a name="new_AutomateClient_new"></a>
### new AutomateClient(options)
BrowserStack Automate API.
<br/>
Spec: [https://www.browserstack.com/automate/rest-api](https://www.browserstack.com/automate/rest-api)


| Param | Type | Description |
| --- | --- | --- |
| options | <code>object</code> | Options for AutomateClient. Optional. |
| options.username | <code>string</code> | Username for the BrowserStack account. Optional. If not supplied, `BROWSERSTACK_USERNAME` environment variable is used. |
| options.key | <code>string</code> | API Key for this product subscription. Optional. If not supplied, `BROWSERSTACK_KEY` environment variable is used. |
| options.returnHeaders | <code>boolean</code> | Return the API response headers along with the response. If enabled, the response will be available under the `data` node of the result object. Default: `false`. |
| options.useCache | <code>boolean</code> | Cache the list of browsers returned by the `getBrowsers()` method. Optional. Default: `true`. |
| options.cacheExpiry | <code>number</code> | Time in milliseconds after which the cache expires. Optional. Default: `864e5`. |

<a name="AutomateClient+getBrowsers"></a>
### automateClient.getBrowsers(callback) ⇒ <code>Promise</code>
Fetches all available browsers.

Note that this method may returned cached data. To turn off caching,
please create an instance of this class with `options.useCache = false`.

**Kind**: instance method of <code>[AutomateClient](#AutomateClient)</code>
**Returns**: <code>Promise</code> - Bluebird Promise object
**Access:** public

| Param | Type | Description |
| --- | --- | --- |
| callback | <code>callback</code> | Optional callback. Use promise or callback. |

<a name="AutomateClient+getStatus"></a>
### automateClient.getStatus(callback) ⇒ <code>Promise</code>
Fetches information about the current Automate subscription,
including maximum no. of parallel sessions allowed and the no. of parallel
sessions currently running.

**Kind**: instance method of <code>[AutomateClient](#AutomateClient)</code>
**Returns**: <code>Promise</code> - Bluebird Promise object
**Access:** public

| Param | Type | Description |
| --- | --- | --- |
| callback | <code>callback</code> | Optional callback. Use promise or callback. |

<a name="AutomateClient+getProjects"></a>
### automateClient.getProjects(callback) ⇒ <code>Promise</code>
Projects are organizational structures for builds.

**Kind**: instance method of <code>[AutomateClient](#AutomateClient)</code>
**Returns**: <code>Promise</code> - Bluebird Promise object
**Access:** public

| Param | Type | Description |
| --- | --- | --- |
| callback | <code>callback</code> | Optional callback. Use promise or callback. |

<a name="AutomateClient+getProject"></a>
### automateClient.getProject(projectId, callback) ⇒ <code>Promise</code>
Fetches the properties of a project by its project ID.

**Kind**: instance method of <code>[AutomateClient](#AutomateClient)</code>
**Returns**: <code>Promise</code> - Bluebird Promise object
**Access:** public

| Param | Type | Description |
| --- | --- | --- |
| projectId | <code>string</code> | Project ID for the project to be fetched. |
| callback | <code>callback</code> | Optional callback. Use promise or callback. |

<a name="AutomateClient+getBuilds"></a>
### automateClient.getBuilds(options, callback) ⇒ <code>Promise</code>
Builds are organizational structures for tests.

**Kind**: instance method of <code>[AutomateClient](#AutomateClient)</code>
**Returns**: <code>Promise</code> - Bluebird Promise object
**Access:** public

| Param | Type | Description |
| --- | --- | --- |
| options | <code>object</code> | Options for this request. |
| options.limit | <code>number</code> | Maximum no. of results to be displayed. Default: 10. |
| options.status | <code>string</code> | Values: running, done, failed. |
| callback | <code>callback</code> | Optional callback. Use promise or callback. |

<a name="AutomateClient+getBuildSessions"></a>
### automateClient.getBuildSessions(buildId, options, callback) ⇒ <code>Promise</code>
Fetches the list of sessions available for a given build.

**Kind**: instance method of <code>[AutomateClient](#AutomateClient)</code>
**Returns**: <code>Promise</code> - Bluebird Promise object
**Access:** public

| Param | Type | Description |
| --- | --- | --- |
| buildId | <code>string</code> | Build ID for the build to be queried. |
| options | <code>object</code> | Options for this request. |
| options.limit | <code>number</code> | Maximum no. of results to be displayed. Default: 10. |
| options.status | <code>string</code> | Values: running, done, failed. |
| callback | <code>callback</code> | Optional callback. Use promise or callback. |

<a name="AutomateClient+getSession"></a>
### automateClient.getSession(sessionId, callback) ⇒ <code>Promise</code>
Gets the properties of an Automate session by its session ID.

**Kind**: instance method of <code>[AutomateClient](#AutomateClient)</code>
**Returns**: <code>Promise</code> - Bluebird Promise object
**Access:** public

| Param | Type | Description |
| --- | --- | --- |
| sessionId | <code>string</code> | Session ID for the session to be fetched. |
| callback | <code>callback</code> | Optional callback. Use promise or callback. |

<a name="AutomateClient+setStatus"></a>
### automateClient.setStatus(sessionId, data, callback) ⇒ <code>Promise</code>
Sets the status for an Automate session.

**Kind**: instance method of <code>[AutomateClient](#AutomateClient)</code>
**Returns**: <code>Promise</code> - Bluebird Promise object
**Access:** public

| Param | Type | Description |
| --- | --- | --- |
| sessionId | <code>string</code> | Session ID for the session to be queried. |
| data | <code>object</code> | Properties to be set. |
| data.status | <code>string</code> | Set the status. Values: completed, error. |
| data.reason | <code>string</code> | Set the reason for the change. Optional. |
| callback | <code>callback</code> | Optional callback. Use promise or callback. |

<a name="AutomateClient+getSessionLogs"></a>
### automateClient.getSessionLogs(sessionId, callback) ⇒ <code>Promise</code>
Retrieves the logs for an Automate session.

**Kind**: instance method of <code>[AutomateClient](#AutomateClient)</code>
**Returns**: <code>Promise</code> - Bluebird Promise object
**Access:** public

| Param | Type | Description |
| --- | --- | --- |
| sessionId | <code>string</code> | Session ID for the session to be queried. |
| callback | <code>callback</code> | Optional callback. Use promise or callback. |

<a name="AutomateClient+recycleKey"></a>
### automateClient.recycleKey(callback) ⇒ <code>Promise</code>
Obtains a new access key.
Note: The same access key is used for Automate and Local Testing.

**Kind**: instance method of <code>[AutomateClient](#AutomateClient)</code>
**Returns**: <code>Promise</code> - Bluebird Promise object
**Access:** public

| Param | Type | Description |
| --- | --- | --- |
| callback | <code>callback</code> | Optional callback. Use promise or callback. |



<a name="ScreenshotsClient"></a>
## ScreenshotsClient
Create and manage Screenshot jobs running under the BrowserStack Screenshots API.

**Kind**: global class
**Access:** public
**Version**: v1

* [ScreenshotsClient](#ScreenshotsClient)
* [new ScreenshotsClient(options)](#new_ScreenshotsClient_new)
* [.getBrowsers(callback)](#ScreenshotsClient+getBrowsers) ⇒ <code>Promise</code>
* [.createJob(options, callback)](#ScreenshotsClient+createJob) ⇒ <code>Promise</code>
* [.getJob(jobId, callback)](#ScreenshotsClient+getJob) ⇒ <code>Promise</code>

<a name="new_ScreenshotsClient_new"></a>
### new ScreenshotsClient(options)
BrowserStack Screenshots API.
<br/>
Spec: [https://www.browserstack.com/screenshots/api](https://www.browserstack.com/screenshots/api)


| Param | Type | Description |
| --- | --- | --- |
| options | <code>object</code> | Options for ScreenshotsClient. Optional. |
| options.username | <code>string</code> | Username for the BrowserStack account. Optional. If not supplied, `BROWSERSTACK_USERNAME` environment variable is used. |
| options.key | <code>string</code> | API Key for this product subscription. Optional. If not supplied, `BROWSERSTACK_KEY` environment variable is used. |
| options.returnHeaders | <code>boolean</code> | Return the API response headers along with the response. If enabled, the response will be available under the `data` node of the result object. Default: `false`. |
| options.useCache | <code>boolean</code> | Cache the list of browsers returned by the `getBrowsers()` method. Optional. Default: `true`. |
| options.cacheExpiry | <code>number</code> | Time in milliseconds after which the cache expires. Optional. Default: `864e5`. |

<a name="ScreenshotsClient+getBrowsers"></a>
### screenshotsClient.getBrowsers(callback) ⇒ <code>Promise</code>
Fetches all available browsers.

Note that this method may returned cached data. To turn off caching,
please create an instance of this class with `options.useCache = false`.

**Kind**: instance method of <code>[ScreenshotsClient](#ScreenshotsClient)</code>
**Returns**: <code>Promise</code> - Bluebird Promise object
**Access:** public

| Param | Type | Description |
| --- | --- | --- |
| callback | <code>callback</code> | Optional callback. Use promise or callback. |

<a name="ScreenshotsClient+createJob"></a>
### screenshotsClient.createJob(options, callback) ⇒ <code>Promise</code>
Creates a new Screenshots Job.

**Kind**: instance method of <code>[ScreenshotsClient](#ScreenshotsClient)</code>
**Returns**: <code>Promise</code> - Bluebird Promise object
**Access:** public

| Param | Type | Description |
| --- | --- | --- |
| options | <code>object</code> | Options for this request. |
| options.url | <code>string</code> | URL of the desired page. |
| options.os | <code>string</code> | OS you want to test. |
| options.os_version | <code>string</code> | OS version you want to test. |
| options.browser | <code>string</code> | Browser you want to test. |
| options.browser_version | <code>string</code> | Browser version you want to test. |
| options.device | <code>string</code> | Device to be used (skip for desktop). |
| options.orientation | <code>string</code> | Required if specifying the screen orientation for the device. Values: portrait, landscape. Default: portrait. |
| options.mac_res | <code>string</code> | Screen resolution for browsers on OSX. Values: 1024x768, 1280x960, 1280x1024, 1600x1200, 1920x1080. |
| options.win_res | <code>string</code> | Screen resolution for browsers on Windows. Values: 1024x768, 1280x1024. |
| options.quality | <code>string</code> | Quality of the screenshot. Values: Original, Compressed. |
| options.local | <code>boolean</code> | Required if the page is local and that a Local Testing connection has been set up. |
| options.wait_time | <code>number</code> | Time to wait (seconds) before taking the screenshot. Values: 2, 5, 10, 15, 20, 60. |
| options.callback_url | <code>string</code> | Publicly accessible URL to be used to send results after processing is complete. |
| callback | <code>callback</code> | Optional callback. Use promise or callback. |

<a name="ScreenshotsClient+getJob"></a>
### screenshotsClient.getJob(jobId, callback) ⇒ <code>Promise</code>
Gets the properties of a Screenshots Job.

**Kind**: instance method of <code>[ScreenshotsClient](#ScreenshotsClient)</code>
**Returns**: <code>Promise</code> - Bluebird Promise object
**Access:** public

| Param | Type | Description |
| --- | --- | --- |
| jobId | <code>string</code> | Job ID for the screenshots job. |
| callback | <code>callback</code> | Optional callback. Use promise or callback. |



* * *

## TODO
- Tests
Please refer to the [documentation](https://shirish87.github.io/browserstack-client/api/variables/BrowserStack.html) for methods available for each of these clients.

0 comments on commit 4e4ef9c

Please sign in to comment.