browserstack-client • Readme | API

---

browserstack-client / LocalTestingClient

Class: LocalTestingClient

Represents a client for interacting with the BrowserStack Local API.

Index

• getBinaryInstances — Retrieves a list of recent Local binary instances from the server.

• getBinaryInstance — Retrieves details of a Local binary instance from the server.

• disconnectBinaryInstance — Disconnects a binary instance.

Extends

• APIClient

Constructors

new LocalTestingClient(options)

new LocalTestingClient(options?): LocalTestingClient

Constructs a new instance of the ScreenshotsClient class.

Parameters

Parameter	Type	Description
options?	LocalTestingOptions	Optional configuration options for the client.

Returns

LocalTestingClient

Overrides

APIClient.constructor

Source

src/local-testing.ts:23

Methods

getBinaryInstances()

getBinaryInstances(query?, options?): Promise<Object[]>

Retrieves a list of recent Local binary instances from the server.

Parameters

Parameter	Type	Description
query?	Omit<Object, "auth_token">	-
options?	APIFetchOptions<Object>	The fetch options for the request.

Returns

Promise<Object[]>

A promise that resolves to a fetch response containing the list of active Local instances.

Source

src/local-testing.ts:44

---

getBinaryInstance()

getBinaryInstance(localInstanceId, query?, options?): Promise<Object>

Retrieves details of a Local binary instance from the server.

Parameters

Parameter	Type	Description
localInstanceId	string	The ID of the local binary instance to retrieve.
query?	Omit<Object, "auth_token">	Optional query parameters for the request.
options?	APIFetchOptions<Object>	Optional fetch options for the request.

Returns

Promise<Object>

A promise that resolves to the retrieved local binary instance.

Member	Type	Description
id	string	Description Unique identifier for the Local instance. Example QUERTY1
email	string	Description User account that started the Local instance. Example john@browserstack.com
hostname	string	Description Hostname for the machine running the Local instance. Example my-local-box
lastActiveOn	string	Description Timestamp at which the Local instance was last active. Example 2013-03-14 16:25:45 UTC
startTime	string	Description Timestamp at which the Local instance was started. Example 2013-03-14 16:25:45 UTC
endTime	string	Description Timestamp at which the Local instance was terminated. Example 2013-03-14 16:25:45 UTC
disconnectReason	string	Description Reason for termination of the Local instance. Example User terminated the instance.
commandLineParams	string	Description Command line parameters used to start the Local instance. Example --key <access_key> --enable-logging-for-api --local-identifier <local_identifier>
localIdentifier	string	Description Identifier for the Local instance. Example 4207442b2b0567368956dba064c22a3235a76214
public-IP	string	Description Public IP address of the machine running the Local instance. Example 8.8.4.4
privateIP	string[]	Example [ "127.0.0.1", "10.100.100.1" ]

Throws

If no local binary instance is found with the specified ID.

Source

src/local-testing.ts:71

---

disconnectBinaryInstance()

disconnectBinaryInstance(localInstanceId, query?, options?): Promise<string>

Disconnects a binary instance.

Parameters

Parameter	Type	Description
localInstanceId	string	The ID of the local binary instance to disconnect.
query?	Omit<Object, "auth_token">	Optional query parameters for the request.
options?	APIFetchOptions<Object>	Optional API fetch options.

Returns

Promise<string>

A promise that resolves to a string representing the message from the server.

Source

src/local-testing.ts:109