Primary shared / external storage root—the directory users treat as “SD card” space, even on devices without a removable card. It is world-readable in the classic model and may be mounted when the device is connected to a PC.

On multi-user devices each user has isolated shared storage; your process only sees the current user’s tree. When multiple physical volumes exist, this path is the primary volume users interact with; use Android APIs such as Context.getExternalFilesDirs, getExternalCacheDirs, or getExternalMediaDirs for secondary volumes.

Prefer Context.getExternalFilesDir (and similar) for app-private files so uninstall can wipe them. Put media meant for other apps under the appropriate public directory helpers instead of dumping files at this root.

Legacy read/write runtime permissions apply on older API levels; on modern releases prefer scoped storage APIs that do not require broad storage permission.

The absolute path may change across OS versions—store relative paths inside this tree if you must persist locations.

Returns

string

fingerprint

• get fingerprint(): string

Unique build fingerprint (Build.FINGERPRINT).

Returns

string

hardware

• get hardware(): string

Hardware platform name (Build.HARDWARE).

Returns

string

imei

• get imei(): null | string

IMEI when available and permitted. May throw if your app lacks carrier identifiers permission; from Android 10 ordinary apps generally cannot read IMEI.

Returns

null | string

macAddress

• get macAddress(): null | string

Best-effort Wi-Fi MAC. Returns null when unavailable.

Note

From Android 6 (API 23) onward, non-privileged code usually sees a randomized placeholder such as 02:00:00:00:00:00, not the factory MAC.

Example

"nodejs";
const { device } = require("device");
const macAddress = device.macAddress;
if (macAddress) {
  console.log("MAC:", macAddress);
} else {
  console.log("MAC unavailable");
}

Returns

null | string

memoryInfo

• get memoryInfo(): MemoryInfo

RAM summary: total, available, low-memory flag, etc. Values are in bytes.

Example

"nodejs";
const { device } = require("device");
console.log(`total: ${device.memoryInfo.totalMem / 1024 / 1024} MB`);
console.log(device.memoryInfo);

Returns

MemoryInfo

product

• get product(): Product

Marketing / SKU metadata: product name, device codename, board, brand, model.

Example

"nodejs";
const { device } = require("device");
console.log(device.product);
// {
//   name: 'mars',
//   device: 'mars',
//   board: 'mars',
//   brand: 'Xiaomi',
//   model: 'M2102K1AC'
// }

Name	Type	Description
`type`	`StreamType`	Stream id (see `StreamType`).

Name	Type	Description
`type`	`StreamType`	Stream id.

Name	Type	Default	Description
`type`	`StreamType`	`undefined`	Stream id (see `StreamType`).
`volume`	`number`	`undefined`	Target index within [min, max] from `getVolumeRange`.
`flags`	`string`[]	`[]`	Optional hints such as `SHOW_UI`, `PLAY_SOUND`, `VIBRATE`. See `AudioManager` flag constants (e.g. `FLAG_PLAY_SOUND`).

Returns

void

vibrate

▸ vibrate(millis): void

Vibrate for millis milliseconds. Typically requires the hosting app to be in the foreground (platform policy).

Parameters

Name	Type	Description
`millis`	`number`	Duration in milliseconds.

Returns

void