Version: next

lstat/stat

Get file information, similar to Linux lstat/stat system calls/commands

interface AdbSyncStat {
  mode: number;
  size: bigint;
  mtime: bigint;
  get type(): LinuxFileType;
  get permission(): number;

  uid?: number;
  gid?: number;
  atime?: bigint;
  ctime?: bigint;
}

declare class AdbSync {
  get supportsStat(): boolean;
  lstat(path: string): Promise<AdbSyncStat>;
  stat(path: string): Promise<AdbSyncStat>;
}

	`lstat` (Android 7 and below)	`lstat` (Android 8 and above)	`stat`
Android version	All	8	8
ADB feature name	None	`stat_v2`	`stat_v2`
Sync command	`STAT`	`LST2`	`STA2`
Follow symlinks	No	No	Yes
Size larger than 4GB	No	Yes	Yes
Returns `uid`, `gid`, `atime` and `ctime`	No	Yes	Yes

mtime, atime and ctime are in seconds since Unix epoch.

AdbSync#supportsStat property can be used to check if the device supports LST2 and STA2 commands (on Android 8 and above).

Errors

For lstat on Android 8 and above and stat, if a file system error occurs, a normal Error with message set to the error name (e.g. ENOENT) will be thrown.

All error code and names are:

EACCES = 13
EEXIST = 17
EFAULT = 14
EFBIG = 27
EINTR = 4
EINVAL = 22
EIO = 5
EISDIR = 21
ELOOP = 40
EMFILE = 24
ENAMETOOLONG = 36
ENFILE = 23
ENOENT = 2
ENOMEM = 12
ENOSPC = 28
ENOTDIR = 20
EOVERFLOW = 75
EPERM = 1
EROFS = 30
ETXTBSY = 26

For lstat on Android 7 and below, the returned AdbSyncStat will have all fields set to 0.

Example

const stat = await sync.stat("/sdcard/Download");
console.log(stat);

Equivalent ADB command

adb shell stat /sdcard/Download

Errors​

Example​

Errors

Example