Class Client

Retrieves current battery status. Analogous to adb -s <serial> shell dumpsys battery .

Deletes all data associated with a package from the device. Analogous to adb shell pm clear <pkg>.

Connects to device over local network.

Example

adb.map(async (device) => {
   await device.tcpip();
   const [ip] = await device.getIpAddress();
   await adb.connect(ip);
});
Copy

Copies data with srcPath to destPath parameter. Analogous to adb shell cp <src> <dest>.

Enables to execute any custom command.

Example

class MyCommand extends Command<number> {
  protected autoEnd = true;
  private arg: string;
  constructor(connection: Connection, arg: string) {
      super(connection);
      this.arg = arg;
  }
  async execute(): Promise<number> {
      const reply = await this.initExecute(this.arg);
      switch (reply) {
          case Reply.OKAY:
              const value = await this.parser.readValue();
              return parseInt(value.toString(), 10);
          case Reply.FAIL:
              throw await this.parser.readError();
          default:
              return parseInt(reply, 10);
         }
     }
 }
Copy

Enables to execute any custom transport command.

Example

class MyCommand extends TransportCommand<null> {
   protected keepAlive = false;
   private arg: string;
   constructor(connection: Connection, serial: string, arg: string) {
       super(connection, serial);
       this.arg = arg;
   }
   protected get Cmd() {
       return 'test '.concat(this.arg);
   }
   protected postExecute(): null {
       return null;
   }
}
Copy

Disconnects from the given device.

Sends draganddrop input command to the device shell. Analogous to adb shell input touchscreen draganddrop x1 y1 x2 y2. Default input source is touchscreen.

Executes a given command via adb console interface.

Executes a given command on specific device via adb console interface. Analogous to adb -s <serial> <command>.

Executes a given command on specific device shell via adb console interface. Analogous to adb -s <serial> shell <command> .

Gets file stats for specified path. Analogous to adb stat <filepath>.

Forwards socket connections from the ADB server host (local) to the device (remote). Analogous to adb forward <local> <remote>.

Example

adb.forward('serial', 'tcp:9222', 'localabstract:chrome_devtools_remote')
Copy

Gets the device path of the device identified by the device.

Gets the ipv4 addresses of default wlan interface.

Gets property from the device. Analogues to adb shell getprop <prop>.

Gets the serial number of the device. Meant for getting serial number of local devices. Analogous to adb shell getprop ro.serialno.

Gets setting from the device. Analogues to adb shell settings get <mode> <name>.

Installs an apk to the device. Analogous to adb install <pkg>.

Tells if a package is installed or not.

Sends keyevent input command to the device shell. Analogous to adb shell input keyboard keyevent <code>. Default input source is keyboard.

Kills the adb server.

Force stops given package. Analogous to adb shell am force-stop <package>.

Gets the list of currently connected devices and emulators.

Lists features of the device. Analogous to adb shell pm list features.

Lists all forwarded connections. Analogous to adb forward --list.

Lists installed packages. Analogous to adb shell pm list packages.

Lists properties of the device. Analogous to adb shell getprop.

Lists all reversed connections. Analogous to adb reverse --list.

Lists settings of the device. Analogues to adb shell settings list <mode>.

Maps through all connected devices.

Creates directory specified by path parameter. Analogous to adb shell mkdir <path>.

Moves data with srcPath to destPath parameter. Analogous to adb shell mv <src> <dest>.

Opens logcat. Analogous to adb logcat.

See

LogcatReader and LogcatOptions for more details.

Example

import { Client, Priority } from 'adb-ts';
const adb = new Client();
const logcat = await adb.openLogcat('serial', {
    filter: (entry) => entry.priority > Priority.INFO
});
logcat.on('entry', (entry) => {
    console.log(entry);
});
Copy

Establishes a new monkey connection on port 1080.

Opens a direct TCP connection to specified port on the device. Analogous to adb tcp <port>:<host>.

Example

const socket = await adb.openTcp('serial', 5555);
// socket.write(...)
Copy

Sends roll input command to the device shell. Analogous to adb shell input trackball press. Default input source is trackball.

Gets a PullTransfer instance.

See

PullTransfer

Example

let data = '';
const transfer = await adb.pull('serial', '/path')
transfer.on('data', (chunk) => {
    data += chunk.toString();
});
transfer.on('end', () => {
    console.log(data);
});
Copy

Wraps pull method, reads the file content and resolves with the output.

Wraps pull method, reads the content of file on the device and write it to a file on the machine.

Gets a PushTransfer instance.

See

PushTransfer

Example

const transfer = await adb.push('serial', '/path-src', '/path-dest')
transfer.on('end', () => { });
Copy

Wraps push method, provides API for quick data writing.

Wraps push method, reads the content of file on the host to a file on the device.

Puts setting on the device. Analogues to adb shell settings put <mode> <name> <value>.

Reads given directory. The path should start with /.

Reboots the device. Analogous to adb reboot.

Attempts to remount the /system partition in read-write mode. Can be done on a rooted device. Analogous to adb remount. Analogous to adb remount

Reverses socket connections from the device (remote) to the ADB server host (local). Analogous to adb reverse <remote> <local>.

Example

adb.reverse('serial', 'localabstract:chrome_devtools_remote', 'tcp:9222')
Copy

Removes file/folder specified by path parameter. Analogous to adb shell rm <path>.

Sends roll input command to the device shell. Analogous to adb shell input trackball roll <x> <y>. Default input source is trackball.

Attempts to which the device to the root mode. Analogous to adb root.

Takes a screenshot on the specified device. Analogous to adb shell screencap -p.

Sets property on the device. Analogues to adb shell setprop <prop> <value>.

Executes a given shell command via adb console interface. Analogous to adb -s <serial> shell <command>.

Shuts the device down. Analogous to adb reboot -p.

Starts a new activity with options. Analogous to adb shell am start <pkg./activity>.

Starts adb server if not running.

Starts a new service with options. Analogous to adb shell am startservice <pkg> <service>.

Sends swipe input command to the device shell. Analogous to adb shell input touchscreen swipe x1 y1 x2 y2. Default input source is touchscreen.

Sends tap input command to the device shell. Analogous to adb shell input touchscreen tap <x> <y>. Default input source is touchscreen.

Puts the device ADB daemon into tcp mode. Afterwards it is possible to use connect method. Analogous to adb tcpip 5555.

Sends text input command to the device shell. Analogous to adb shell input touchscreen text '<text>'. Default input source is touchscreen.

Updates access and modification times of file specified by path parameter, or creates a new file. Analogous to adb shell touch <filename>.