Generated API reference
@udid-tools/device-info
Section titled “@udid-tools/device-info”Interfaces
Section titled “Interfaces”DeviceInfo
Section titled “DeviceInfo”A resolved hardware product identifier.
Properties
Section titled “Properties”family
Section titled “family”
readonlyfamily:DeviceFamily
identifier
Section titled “identifier”
readonlyidentifier:string
readonlymodel:string
FormattedOsVersion
Section titled “FormattedOsVersion”Presentation values derived from an OS build without losing the original build string.
Properties
Section titled “Properties”copyValue
Section titled “copyValue”
readonlycopyValue:string
displayValue
Section titled “displayValue”
readonlydisplayValue:string
rawBuild?
Section titled “rawBuild?”
readonlyoptionalrawBuild?:string
KnownOsVersion
Section titled “KnownOsVersion”A known build from the package catalog.
Properties
Section titled “Properties”
readonlybuild:string
readonlyknown:true
platform
Section titled “platform”
readonlyplatform:"iOS"|"iPadOS"
releaseChannel
Section titled “releaseChannel”
readonlyreleaseChannel:OsReleaseChannel
releaseLabel?
Section titled “releaseLabel?”
readonlyoptionalreleaseLabel?:string
version
Section titled “version”
readonlyversion:string
OsVersionInput
Section titled “OsVersionInput”Input accepted by OS resolution and formatting helpers.
Properties
Section titled “Properties”
readonlybuild:string
productIdentifier
Section titled “productIdentifier”
readonlyproductIdentifier:string
UnknownOsVersion
Section titled “UnknownOsVersion”A build that is not present in the package catalog.
Properties
Section titled “Properties”
readonlybuild:string
readonlyknown:false
platform
Section titled “platform”
readonlyplatform:OsPlatform
Type Aliases
Section titled “Type Aliases”DeviceFamily
Section titled “DeviceFamily”DeviceFamily =
"iPhone"|"iPad"
A supported hardware family. New families may be added in minor releases.
OsPlatform
Section titled “OsPlatform”OsPlatform =
"iOS"|"iPadOS"|"unknown"
A platform name derived from the device family and known OS version.
OsReleaseChannel
Section titled “OsReleaseChannel”OsReleaseChannel =
"stable"|"beta"|"release-candidate"|"rapid-security-response"
The release stage encoded by a known build.
OsVersionResolution
Section titled “OsVersionResolution”OsVersionResolution =
KnownOsVersion|UnknownOsVersion
The lossless result of resolving an OS build.
Functions
Section titled “Functions”formatOsVersion()
Section titled “formatOsVersion()”formatOsVersion(
input):FormattedOsVersion
Format a build for display and copying while preserving the original build value.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”getDevice()
Section titled “getDevice()”getDevice(
productIdentifier):DeviceInfo|undefined
Resolve an exact Apple product identifier to structured device information.
Parameters
Section titled “Parameters”productIdentifier
Section titled “productIdentifier”string
Returns
Section titled “Returns”DeviceInfo | undefined
getDeviceModelName()
Section titled “getDeviceModelName()”getDeviceModelName(
productIdentifier):string|undefined
Resolve an exact Apple product identifier to its marketing model name.
Parameters
Section titled “Parameters”productIdentifier
Section titled “productIdentifier”string
Returns
Section titled “Returns”string | undefined
getOsVersion()
Section titled “getOsVersion()”getOsVersion(
input):OsVersionResolution
Resolve an exact OS build number while preserving unknown future builds.