Skip to main content

api/setup

setup()โ€‹

setup(SetupParameters: SetupParameters): Promise<boolean>

setup initializes the Client and executes connect() if necessary. It returns a promise that resolves to a boolean that indicates whether the Client is paired to the application to which it's attempting to connect.

Parametersโ€‹

ParameterTypeDescription
SetupParametersSetupParametersparamaters for the setup function

Returnsโ€‹

Promise<boolean>

  • a promise that resolves to a boolean that indicates whether the Client is paired to the application to which it's attempting to connect

Sourceโ€‹

api/setup.ts:36