@u4/adbkit
    Preparing search index...

    Class Client

    Hierarchy

    • EventEmitter
      • Client
    Index
    options: ClientOptions & Required<Pick<ClientOptions, "host" | "bin">>
    • get bin(): string

      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 string

    • get host(): string

      host to connect default is 127.0.0.1

      Returns string

    • get port(): string | number

      The port where the ADB server is listening. Defaults to 5037.

      Returns string | number

    • The Symbol.for('nodejs.rejection') method is called in case a promise rejection happens when emitting an event and captureRejections is enabled on the emitter. It is possible to use events.captureRejectionSymbol in place of Symbol.for('nodejs.rejection').

      import { EventEmitter, captureRejectionSymbol } from 'node:events';

      class MyClass extends EventEmitter {
      constructor() {
      super({ captureRejections: true });
      }

      [captureRejectionSymbol](err, event, ...args) {
      console.log('rejection happened for', event, 'with', err, ...args);
      this.destroy(err);
      }

      destroy(err) {
      // Tear the resource down here.
      }
      }

      Parameters

      • error: Error
      • event: string | symbol
      • ...args: any[]

      Returns void

      v13.4.0, v12.16.0

    • Alias for emitter.on(eventName, listener).

      Type Parameters

      • E extends string | symbol

      Parameters

      • eventName: string | symbol
      • listener: (...args: any[]) => void

      Returns this

      v0.1.26

    • Connects to the given device, which must have its ADB daemon running in tcp mode (see client.tcpip()) and be accessible on the same network. Same as adb connect <host>:<port>.

      Parameters

      • host: string

        The target host. Can also contain the port, in which case the port argument is not used and can be skipped.

      • port: number = 5555

        Optional. The target port. Defaults to 5555

      Returns Promise<boolean>

      true is a new connetion is etablish, or false if already connected.

      switch to TCP mode and set up a forward for Chrome devtools

      import Adb from '@u4/adbkit';
      const client = Adb.createClient();
      // Note: be careful with using `client.listDevices()` together with `client.tcpip()`
      // and other similar methods that modify the connection with ADB. You might have the
      // same device twice in your device list (i.e. one device connected via both USB and
      // TCP), which can cause havoc if run simultaneously.

      const test = async () => {
      try {
      const devices = await client.listDevices();
      for (const device of devices) {
      const deviceClient = device.getClient();
      const port = await deviceClient.tcpip();
      // Switching to TCP mode causes ADB to lose the device for a
      // moment, so let's just wait till we get it back.
      await deviceClient.waitForDevice();
      const [ip] = await deviceClient.getIpAddress();
      await client.connect(ip, port);
      const deviceTCP = client.getDevice(`${ip}:${port}`);
      // It can take a moment for the connection to happen.
      await deviceTCP.waitForDevice();
      await deviceTCP.forward('tcp:9222', 'localabstract:chrome_devtools_remote');
      console.log(`Setup devtools on "${device.id}"`);
      }
      } catch (err) {
      console.error('Something went wrong:', err.stack);
      }
      };
    • Disconnects from the given device, which should have been connected via client.connect() or just adb connect <host>:<port>.

      Parameters

      • host: string

        The target host. Can also contain the port, in which case the port argument is not used and can be skipped. In other words you can just put the id you got from client.connect() here and it will be fine.

      • port: number = 5555

        Optional. The target port. Defaults to 5555.

      Returns Promise<DeviceClient>

      The disconnected device ID. Will no longer be usable as a serial in other commands until you've connected again.

    • Type Parameters

      • K extends "error"

      Parameters

      Returns boolean

    • Returns an array listing the events for which the emitter has registered listeners.

      import { EventEmitter } from 'node:events';

      const myEE = new EventEmitter();
      myEE.on('foo', () => {});
      myEE.on('bar', () => {});

      const sym = Symbol('symbol');
      myEE.on(sym, () => {});

      console.log(myEE.eventNames());
      // Prints: [ 'foo', 'bar', Symbol(symbol) ]

      Returns (string | symbol)[]

      v6.0.0

    • Returns the current max listener value for the EventEmitter which is either set by emitter.setMaxListeners(n) or defaults to events.defaultMaxListeners.

      Returns number

      v1.0.0

    • This kills the ADB server. Note that the next connection will attempt to start the server again when it's unable to connect

      Returns Promise<boolean>

      true

    • Gets the list of currently connected devices and emulators.

      Returns Promise<Device[]>

      An array of device objects. Each device object has id, type, and getClient().

    • Returns the number of listeners listening for the event named eventName. If listener is provided, it will return how many times the listener is found in the list of the listeners of the event.

      Type Parameters

      • E extends string | symbol

      Parameters

      • eventName: string | symbol

        The name of the event being listened for

      • Optionallistener: (...args: any[]) => void

        The event handler function

      Returns number

      v3.2.0

    • Returns a copy of the array of listeners for the event named eventName.

      server.on('connection', (stream) => {
      console.log('someone connected!');
      });
      console.log(util.inspect(server.listeners('connection')));
      // Prints: [ [Function] ]

      Type Parameters

      • E extends string | symbol

      Parameters

      • eventName: string | symbol

      Returns ((...args: any[]) => void)[]

      v0.1.26

    • Adds the listener function to the beginning of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventName and listener will result in the listener being added, and called, multiple times.

      server.prependListener('connection', (stream) => {
      console.log('someone connected!');
      });

      Returns a reference to the EventEmitter, so that calls can be chained.

      Type Parameters

      • E extends string | symbol

      Parameters

      • eventName: string | symbol

        The name of the event.

      • listener: (...args: any[]) => void

        The callback function

      Returns this

      v6.0.0

    • Adds a one-time listener function for the event named eventName to the beginning of the listeners array. The next time eventName is triggered, this listener is removed, and then invoked.

      server.prependOnceListener('connection', (stream) => {
      console.log('Ah, we have our first user!');
      });

      Returns a reference to the EventEmitter, so that calls can be chained.

      Type Parameters

      • E extends string | symbol

      Parameters

      • eventName: string | symbol

        The name of the event.

      • listener: (...args: any[]) => void

        The callback function

      Returns this

      v6.0.0

    • Returns a copy of the array of listeners for the event named eventName, including any wrappers (such as those created by .once()).

      import { EventEmitter } from 'node:events';
      const emitter = new EventEmitter();
      emitter.once('log', () => console.log('log once'));

      // Returns a new Array with a function `onceWrapper` which has a property
      // `listener` which contains the original listener bound above
      const listeners = emitter.rawListeners('log');
      const logFnWrapper = listeners[0];

      // Logs "log once" to the console and does not unbind the `once` event
      logFnWrapper.listener();

      // Logs "log once" to the console and removes the listener
      logFnWrapper();

      emitter.on('log', () => console.log('log persistently'));
      // Will return a new Array with a single function bound by `.on()` above
      const newListeners = emitter.rawListeners('log');

      // Logs "log persistently" twice
      newListeners[0]();
      emitter.emit('log');

      Type Parameters

      • E extends string | symbol

      Parameters

      • eventName: string | symbol

      Returns ((...args: any[]) => void)[]

      v9.4.0

    • Removes all listeners, or those of the specified eventName.

      It is bad practice to remove listeners added elsewhere in the code, particularly when the EventEmitter instance was created by some other component or module (e.g. sockets or file streams).

      Returns a reference to the EventEmitter, so that calls can be chained.

      Type Parameters

      • E extends string | symbol

      Parameters

      • OptionaleventName: string | symbol

      Returns this

      v0.1.26

    • Removes the specified listener from the listener array for the event named eventName.

      const callback = (stream) => {
      console.log('someone connected!');
      };
      server.on('connection', callback);
      // ...
      server.removeListener('connection', callback);

      removeListener() will remove, at most, one instance of a listener from the listener array. If any single listener has been added multiple times to the listener array for the specified eventName, then removeListener() must be called multiple times to remove each instance.

      Once an event is emitted, all listeners attached to it at the time of emitting are called in order. This implies that any removeListener() or removeAllListeners() calls after emitting and before the last listener finishes execution will not remove them from emit() in progress. Subsequent events behave as expected.

      import { EventEmitter } from 'node:events';
      class MyEmitter extends EventEmitter {}
      const myEmitter = new MyEmitter();

      const callbackA = () => {
      console.log('A');
      myEmitter.removeListener('event', callbackB);
      };

      const callbackB = () => {
      console.log('B');
      };

      myEmitter.on('event', callbackA);

      myEmitter.on('event', callbackB);

      // callbackA removes listener callbackB but it will still be called.
      // Internal listener array at time of emit [callbackA, callbackB]
      myEmitter.emit('event');
      // Prints:
      // A
      // B

      // callbackB is now removed.
      // Internal listener array [callbackA]
      myEmitter.emit('event');
      // Prints:
      // A

      Because listeners are managed using an internal array, calling this will change the position indexes of any listener registered after the listener being removed. This will not impact the order in which listeners are called, but it means that any copies of the listener array as returned by the emitter.listeners() method will need to be recreated.

      When a single function has been added as a handler multiple times for a single event (as in the example below), removeListener() will remove the most recently added instance. In the example the once('ping') listener is removed:

      import { EventEmitter } from 'node:events';
      const ee = new EventEmitter();

      function pong() {
      console.log('pong');
      }

      ee.on('ping', pong);
      ee.once('ping', pong);
      ee.removeListener('ping', pong);

      ee.emit('ping');
      ee.emit('ping');

      Returns a reference to the EventEmitter, so that calls can be chained.

      Type Parameters

      • E extends string | symbol

      Parameters

      • eventName: string | symbol
      • listener: (...args: any[]) => void

      Returns this

      v0.1.26

    • By default EventEmitters will print a warning if more than 10 listeners are added for a particular event. This is a useful default that helps finding memory leaks. The emitter.setMaxListeners() method allows the limit to be modified for this specific EventEmitter instance. The value can be set to Infinity (or 0) to indicate an unlimited number of listeners.

      Returns a reference to the EventEmitter, so that calls can be chained.

      Parameters

      • n: number

      Returns this

      v0.3.5

    • Gets a device tracker. Events will be emitted when devices are added, removed, or their type changes (i.e. to/from offline). Note that the same events will be emitted for the initially connected devices also, so that you don't need to use both client.listDevices() and client.trackDevices().

      Note that as the tracker will keep a connection open, you must call tracker.end() if you wish to stop tracking devices.

      Returns Promise<Tracker>

      Tracking devices

      import Adb from '@u4/adbkit';

      const client = Adb.createClient();
      const test = async () => {
      try {
      const tracker = await client.trackDevices();
      tracker.on('add', (device) => console.log('Device %s was plugged in', device.id));
      tracker.on('remove', (device) => console.log('Device %s was unplugged', device.id));
      tracker.on('end', () => console.log('Tracking stopped'));
      } catch (err) {
      console.error('Something went wrong:', err.stack);
      }
      };

      Tracking devices avoiding offline devices

      import Adb from '@u4/adbkit';

      const client = Adb.createClient();
      const test = async () => {
      try {
      const tracker = await client.trackDevices();
      tracker.on('online', (device) => console.log('Device %s is online', device.id));
      tracker.on('offline', (device) => console.log('Device %s is offline', device.id));
      tracker.on('end', () => console.log('Tracking stopped'));
      } catch (err) {
      console.error('Something went wrong:', err.stack);
      }
      };
    • Queries the ADB server for its version. This is mainly useful for backwards-compatibility purposes.

      Returns Promise<number>

      The version of the ADB server.