appium-adb/build/lib/tools/fs-commands.d.ts

Android Debug Bridge interface

import type { ADB } from '../adb';
import type { TeenProcessExecOptions } from 'teen_process';
/**
 * Verify whether a remote path exists on the device under test.
 *
 * @param remotePath - The remote path to verify.
 * @return True if the given path exists on the device.
 */
export declare function fileExists(this: ADB, remotePath: string): Promise<boolean>;
/**
 * Get the output of _ls_ command on the device under test.
 *
 * @param remotePath - The remote path (the first argument to the _ls_ command).
 * @param opts - Additional _ls_ options.
 * @return The _ls_ output as an array of split lines.
 *                          An empty array is returned of the given _remotePath_
 *                          does not exist.
 */
export declare function ls(this: ADB, remotePath: string, opts?: string[]): Promise<string[]>;
/**
 * Get the size of the particular file located on the device under test.
 *
 * @param remotePath - The remote path to the file.
 * @return File size in bytes.
 * @throws {Error} If there was an error while getting the size of the given file.
 */
export declare function fileSize(this: ADB, remotePath: string): Promise<number>;
/**
 * Forcefully recursively remove a path on the device under test.
 * Be careful while calling this method.
 *
 * @param path - The path to be removed recursively.
 */
export declare function rimraf(this: ADB, path: string): Promise<void>;
/**
 * Send a file to the device under test.
 *
 * @param localPath - The path to the file on the local file system.
 * @param remotePath - The destination path on the remote device.
 * @param opts - Additional options mapping. See
 *                        https://github.com/appium/node-teen_process,
 *                        _exec_ method options, for more information about available
 *                        options.
 */
export declare function push(this: ADB, localPath: string, remotePath: string, opts?: TeenProcessExecOptions): Promise<void>;
/**
 * Receive a file from the device under test.
 *
 * @param remotePath - The source path on the remote device.
 * @param localPath - The destination path to the file on the local file system.
 * @param opts - Additional options mapping. See
 * https://github.com/appium/node-teen_process,
 * _exec_ method options, for more information about available
 * options.
 */
export declare function pull(this: ADB, remotePath: string, localPath: string, opts?: TeenProcessExecOptions): Promise<void>;
/**
 * Recursively create a new folder on the device under test.
 *
 * @param remotePath - The new path to be created.
 * @return mkdir command output.
 */
export declare function mkdir(this: ADB, remotePath: string): Promise<string>;
//# sourceMappingURL=fs-commands.d.ts.map