@u4/adbkit/dist/adb.d.ts

A Typescript client for the Android Debug Bridge.

import Client from './adb/client.js';
export interface AdbOptions {
    /**
     * host to connect default is 127.0.0.1
     */
    host?: string;
    /**
     * The port where the ADB server is listening. Defaults to `5037`.
     */
    port?: number;
    /**
     * As the sole exception, this option provides the path to the `adb` binary, used for starting the server locally if initial connection fails. Defaults to `'adb'`.
     */
    bin?: string;
}
/**
 * Creates a client instance with the provided options. Note that this will not automatically establish a connection, it will only be done when necessary.
 * @param options An object compatible with [Net.connect][net-connect]'s options:
 * **port** The port where the ADB server is listening. Defaults to `5037`.
 * **host** The host of the ADB server. Defaults to `'127.0.0.1'`.
 * **bin** As the sole exception, this option provides the path to the `adb` binary, used for starting the server locally if initial connection fails. Defaults to `'adb'`.
 *
 * @returns The client instance.
 * @example
 * Function you should import and call first
 * ```ts
 * import { createClient } fronm @u4/adbkit
 *
 * const client = createClient();
 * ```

 */
export declare function createClient(options?: AdbOptions): Client;
//# sourceMappingURL=adb.d.ts.map