Class: OS
device.OS
Static helpers for Android OS / SDK metadata: marketing release strings, numeric API level, security patch, and well-known AndroidVersion constants for requiresAndroidVersion guards.
Example
const { OS } = require('device');
console.log(OS.sdkName); // e.g. "7.1"
console.log(OS.sdkVersionCode); // e.g. 25Table of contents
Properties
- ANDROID_BASE
- ANDROID_BASE_1_1
- ANDROID_CUPCAKE
- ANDROID_DONUT
- ANDROID_ECLAIR
- ANDROID_ECLAIR_0_1
- ANDROID_ECLAIR_MR1
- ANDROID_FROYO
- ANDROID_GINGERBREAD
- ANDROID_GINGERBREAD_MR1
- ANDROID_HONEYCOMB
- ANDROID_HONEYCOMB_MR1
- ANDROID_HONEYCOMB_MR2
- ANDROID_ICE_CREAM_SANDWICH
- ANDROID_ICE_CREAM_SANDWICH_MR1
- ANDROID_JELLY_BEAN
- ANDROID_JELLY_BEAN_MR1
- ANDROID_JELLY_BEAN_MR2
- ANDROID_KITKAT
- ANDROID_KITKAT_WATCH
- ANDROID_L
- ANDROID_LOLLIPOP_MR1
- ANDROID_M
- ANDROID_N
- ANDROID_N_MR1
- ANDROID_O
- ANDROID_O_MR1
- ANDROID_P
- ANDROID_Q
- ANDROID_R
- ANDROID_S
Accessors
Methods
Properties
ANDROID_BASE
▪ Static Readonly ANDROID_BASE: AndroidVersion
Android 1.0
See also
ANDROID_BASE_1_1
▪ Static Readonly ANDROID_BASE_1_1: AndroidVersion
Android 1.1
See also
ANDROID_CUPCAKE
▪ Static Readonly ANDROID_CUPCAKE: AndroidVersion
Android 1.5
See also
ANDROID_DONUT
▪ Static Readonly ANDROID_DONUT: AndroidVersion
Android 1.6
See also
ANDROID_ECLAIR
▪ Static Readonly ANDROID_ECLAIR: AndroidVersion
Android 2.0
See also
ANDROID_ECLAIR_0_1
▪ Static Readonly ANDROID_ECLAIR_0_1: AndroidVersion
Android 2.0.1
See also
ANDROID_ECLAIR_MR1
▪ Static Readonly ANDROID_ECLAIR_MR1: AndroidVersion
Android 2.1.x
See also
ANDROID_FROYO
▪ Static Readonly ANDROID_FROYO: AndroidVersion
Android 2.2.x
See also
ANDROID_GINGERBREAD
▪ Static Readonly ANDROID_GINGERBREAD: AndroidVersion
Android 2.3
See also
ANDROID_GINGERBREAD_MR1
▪ Static Readonly ANDROID_GINGERBREAD_MR1: AndroidVersion
Android 2.3.3
See also
ANDROID_HONEYCOMB
▪ Static Readonly ANDROID_HONEYCOMB: AndroidVersion
Android 3.0.x
See also
ANDROID_HONEYCOMB_MR1
▪ Static Readonly ANDROID_HONEYCOMB_MR1: AndroidVersion
Android 3.1.x
See also
ANDROID_HONEYCOMB_MR2
▪ Static Readonly ANDROID_HONEYCOMB_MR2: AndroidVersion
Android 3.2
See also
ANDROID_ICE_CREAM_SANDWICH
▪ Static Readonly ANDROID_ICE_CREAM_SANDWICH: AndroidVersion
Android 4.0
See also
ANDROID_ICE_CREAM_SANDWICH_MR1
▪ Static Readonly ANDROID_ICE_CREAM_SANDWICH_MR1: AndroidVersion
Android 4.0.3
See also
ANDROID_JELLY_BEAN
▪ Static Readonly ANDROID_JELLY_BEAN: AndroidVersion
Android 4.1
See also
ANDROID_JELLY_BEAN_MR1
▪ Static Readonly ANDROID_JELLY_BEAN_MR1: AndroidVersion
Android 4.2
See also
ANDROID_JELLY_BEAN_MR2
▪ Static Readonly ANDROID_JELLY_BEAN_MR2: AndroidVersion
Android 4.3
See also
ANDROID_KITKAT
▪ Static Readonly ANDROID_KITKAT: AndroidVersion
Android 4.4.2
See also
ANDROID_KITKAT_WATCH
▪ Static Readonly ANDROID_KITKAT_WATCH: AndroidVersion
Android 4.4W
See also
ANDROID_L
▪ Static Readonly ANDROID_L: AndroidVersion
Android 5.0
See also
ANDROID_LOLLIPOP_MR1
▪ Static Readonly ANDROID_LOLLIPOP_MR1: AndroidVersion
Android 5.1
See also
ANDROID_M
▪ Static Readonly ANDROID_M: AndroidVersion
Android 6.0
See also
ANDROID_N
▪ Static Readonly ANDROID_N: AndroidVersion
Android 7.0
See also
ANDROID_N_MR1
▪ Static Readonly ANDROID_N_MR1: AndroidVersion
Android 7.1
See also
ANDROID_O
▪ Static Readonly ANDROID_O: AndroidVersion
Android 8.0
See also
ANDROID_O_MR1
▪ Static Readonly ANDROID_O_MR1: AndroidVersion
Android 8.1
See also
ANDROID_P
▪ Static Readonly ANDROID_P: AndroidVersion
Android 9
See also
ANDROID_Q
▪ Static Readonly ANDROID_Q: AndroidVersion
Android 10
See also
ANDROID_R
▪ Static Readonly ANDROID_R: AndroidVersion
Android 11
See also
ANDROID_S
▪ Static Readonly ANDROID_S: AndroidVersion
Android 12
See also
Accessors
incremental
• Static get incremental(): string
Incremental source-control label from the build (often a VCS id).
See also
https://developer.android.com/reference/android/os/Build.VERSION#INCREMENTAL
Returns
string
release
• Static get release(): string
Human-visible release string (for example "14", "7.1.2"). Treat it as opaque text—do not parse or sort it programmatically.
See also
https://developer.android.com/reference/android/os/Build.VERSION#RELEASE
Returns
string
sdkName
• Static get sdkName(): string
Short SDK codename / marketing label (for example "10", "7.0", "4.4W"). On some builds this may read "unknown".
Returns
string
sdkVersionCode
• Static get sdkVersionCode(): number
Current SDK_INT / API level (for example 29 on Android 10, 24 on Android 7.0). See SDK platform release notes for the full mapping table.
See also
https://developer.android.com/reference/android/os/Build.VERSION#SDK_INT
Returns
number
securityPatch
• Static get securityPatch(): string
Security patch level string from the vendor image.
See also
https://developer.android.com/reference/android/os/Build.VERSION#SECURITY_PATCH
Returns
string
Methods
requiresAndroidVersion
▸ Static requiresAndroidVersion(version, message?): void
Throws if the device API level is below version. Use at script startup to fail fast on unsupported Android versions.
Example
"nodejs";
const { OS } = require('device');
OS.requiresAndroidVersion(OS.ANDROID_N);Parameters
| Name | Type | Description |
|---|---|---|
version | AndroidVersion | Minimum supported version (pass one of the OS.ANDROID_* constants). |
message | string | Optional custom error text; defaults to a message like Requires Android ${version.name} (API ${version.code}) when omitted. |
Returns
void