Documentation / local-testing / LocalTestingClient

Class: LocalTestingClient

Defined in: local-testing/src/client.ts:13

Extends

• GeneratedLocalTestingClient

Extended by

• LocalTestingBinary

Constructors

Constructor

new LocalTestingClient(options?): LocalTestingClient

Defined in: local-testing/src/client.ts:16

Parameters

Parameter	Type
options?	LocalTestingOptions

Returns

LocalTestingClient

Overrides

GeneratedLocalTestingClient.constructor

Properties

Property	Modifier	Type	Inherited from	Defined in
authHeader?	readonly	string	GeneratedLocalTestingClient.authHeader	core/src/api-client.ts:50
authToken	readonly	string	-	local-testing/src/client.ts:14
baseUrls	readonly	object	GeneratedLocalTestingClient.baseUrls	core/src/api-client.ts:49
baseUrls.sdk	public	string	-	core/src/api-client.ts:49
baseUrls.sdkCloud	public	string	-	core/src/api-client.ts:49
fetchFn	readonly	{(input, init?): Promise<Response>; (input, init?): Promise<Response>; }	GeneratedLocalTestingClient.fetchFn	core/src/api-client.ts:52
registry	readonly	CodecRegistry	GeneratedLocalTestingClient.registry	core/src/api-client.ts:53
userAgent	readonly	string	GeneratedLocalTestingClient.userAgent	core/src/api-client.ts:51

Methods

disconnectBinaryInstance()

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

Defined in: local-testing/src/client.ts:98

Parameters

Parameter	Type
localInstanceId	string
query?	Omit<{ auth_token: string; }, "auth_token">
options?	ExecuteOptions

Returns

Promise<string>

---

disconnectInstance()

disconnectInstance(localInstanceId, authToken?, options?): Promise<{ apiVersion: string; message: string; metaData: {[key: string]: unknown; params?: {[key: string]: unknown; }; }; }>

Defined in: openapi/generated/local-testing.client.ts:67

Disconnect a Local binary instance

Parameters

Parameter	Type
localInstanceId	string
authToken?	string
options?	ExecuteOptions

Returns

Promise<{ apiVersion: string; message: string; metaData: {[key: string]: unknown; params?: {[key: string]: unknown; }; }; }>

Inherited from

GeneratedLocalTestingClient.disconnectInstance

---

downloadBinary()

downloadBinary(osArch, filenamePrefix?, options?): Promise<{ content: Uint8Array; filename: string; }>

Defined in: local-testing/src/client.ts:126

Parameters

Parameter	Type	Default value
osArch	"win32" | "darwin-x64" | "linux-x64" | "linux-ia32" | "alpine"	undefined
filenamePrefix	string	"BrowserStackLocal"
options?	ExecuteOptions	undefined

Returns

Promise<{ content: Uint8Array; filename: string; }>

---

execute()

protected execute<T>(spec): Promise<T>

Defined in: core/src/api-client.ts:103

Internal

Type Parameters

Type Parameter	Default type
T	unknown

Parameters

Parameter	Type
spec	{[key: string]: unknown; baseUrl?: "sdk" | "sdkCloud"; method: HttpMethod; operationId: string; params?: { path?: Record<string, unknown>; query?: Record<string, unknown>; }; path: string; requestCodec?: string; requestCodecConfig?: unknown; requestInput?: unknown; responseCodec: string; responseCodecConfig: unknown; signal?: AbortSignal; }
spec.baseUrl?	"sdk" | "sdkCloud"
spec.method	HttpMethod
spec.operationId	string
spec.params?	{ path?: Record<string, unknown>; query?: Record<string, unknown>; }
spec.params.path?	Record<string, unknown>
spec.params.query?	Record<string, unknown>
spec.path	string
spec.requestCodec?	string
spec.requestCodecConfig?	unknown
spec.requestInput?	unknown
spec.responseCodec	string
spec.responseCodecConfig	unknown
spec.signal?	AbortSignal

Returns

Promise<T>

Inherited from

GeneratedLocalTestingClient.execute

---

getBinaryInstance()

getBinaryInstance(localInstanceId, query?, options?): Promise<{ commandLineParams?: string; disconnectReason?: string; email: string; endTime?: string; hostname?: string; id: string; lastActiveOn: string; localIdentifier: string; privateIP?: string[]; public-IP?: string; startTime: string; }>

Defined in: local-testing/src/client.ts:62

Parameters

Parameter	Type
localInstanceId	string
query?	Omit<{ auth_token: string; last?: number; state?: "running" | "all"; }, "auth_token">
options?	ExecuteOptions

Returns

Promise<{ commandLineParams?: string; disconnectReason?: string; email: string; endTime?: string; hostname?: string; id: string; lastActiveOn: string; localIdentifier: string; privateIP?: string[]; public-IP?: string; startTime: string; }>

---

getBinaryInstances()

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

Defined in: local-testing/src/client.ts:36

Parameters

Parameter	Type
query?	Omit<{ auth_token: string; last?: number; state?: "running" | "all"; }, "auth_token">
options?	ExecuteOptions

Returns

Promise<object[]>

---

getInstance()

getInstance(localInstanceId, authToken?, options?): Promise<{ apiVersion: string; instances: object[]; metaData: {[key: string]: unknown; params?: {[key: string]: unknown; }; }; }>

Defined in: openapi/generated/local-testing.client.ts:50

Fetches details of a Local binary instance used for local testing. Note that the binary should have been started with the --enable-logging-for-api parameter.

Parameters

Parameter	Type
localInstanceId	string
authToken?	string
options?	ExecuteOptions

Returns

Promise<{ apiVersion: string; instances: object[]; metaData: {[key: string]: unknown; params?: {[key: string]: unknown; }; }; }>

Inherited from

GeneratedLocalTestingClient.getInstance

---

getInstances()

getInstances(authToken?, last?, state?, options?): Promise<{ apiVersion: string; instances: object[]; metaData: {[key: string]: unknown; params?: {[key: string]: unknown; }; }; }>

Defined in: openapi/generated/local-testing.client.ts:33

Fetches list of recent binary instances for local testing. Note that the binary should have been started with the --enable-logging-for-api parameter.

Parameters

Parameter	Type
authToken?	string
last?	string
state?	string
options?	ExecuteOptions

Returns

Promise<{ apiVersion: string; instances: object[]; metaData: {[key: string]: unknown; params?: {[key: string]: unknown; }; }; }>

Inherited from

GeneratedLocalTestingClient.getInstances