1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272
|
# Platform.js v1.3.6
<!-- div class="toc-container" -->
<!-- div -->
## `platform`
* <a href="#platform">`platform`</a>
* <a href="#platformdescription">`platform.description`</a>
* <a href="#platformlayout">`platform.layout`</a>
* <a href="#platformmanufacturer">`platform.manufacturer`</a>
* <a href="#platformname">`platform.name`</a>
* <a href="#platformos">`platform.os`</a>
* <a href="#platformparseuanavigatoruseragent">`platform.parse`</a>
* <a href="#platformprerelease">`platform.prerelease`</a>
* <a href="#platformproduct">`platform.product`</a>
* <a href="#platformtostring">`platform.toString`</a>
* <a href="#platformua">`platform.ua`</a>
* <a href="#platformversion">`platform.version`</a>
<!-- /div -->
<!-- div -->
## `platform.os`
* <a href="#platformosarchitecture">`platform.os.architecture`</a>
* <a href="#platformosfamily">`platform.os.family`</a>
* <a href="#platformostostring">`platform.os.toString`</a>
* <a href="#platformosversion">`platform.os.version`</a>
<!-- /div -->
<!-- /div -->
<!-- div class="doc-container" -->
<!-- div -->
## `platform`
<!-- div -->
<h3 id="platform"><code>platform</code></h3>
[Ⓢ](https://github.com/bestiejs/platform.js/blob/1.3.6/platform.js#L1081 "View in source") [Ⓣ][1]
The platform object.
---
<!-- /div -->
<!-- div -->
<h3 id="platformdescription"><code>platform.description</code></h3>
[Ⓢ](https://github.com/bestiejs/platform.js/blob/1.3.6/platform.js#L1089 "View in source") [Ⓣ][1]
The platform description.
---
<!-- /div -->
<!-- div -->
<h3 id="platformlayout"><code>platform.layout</code></h3>
[Ⓢ](https://github.com/bestiejs/platform.js/blob/1.3.6/platform.js#L1100 "View in source") [Ⓣ][1]
The name of the browser's layout engine.
<br>
<br>
The list of common layout engines include:<br>
"Blink", "EdgeHTML", "Gecko", "Trident" and "WebKit"
---
<!-- /div -->
<!-- div -->
<h3 id="platformmanufacturer"><code>platform.manufacturer</code></h3>
[Ⓢ](https://github.com/bestiejs/platform.js/blob/1.3.6/platform.js#L1113 "View in source") [Ⓣ][1]
The name of the product's manufacturer.
<br>
<br>
The list of manufacturers include:<br>
"Apple", "Archos", "Amazon", "Asus", "Barnes & Noble", "BlackBerry",
"Google", "HP", "HTC", "LG", "Microsoft", "Motorola", "Nintendo",
"Nokia", "Samsung" and "Sony"
---
<!-- /div -->
<!-- div -->
<h3 id="platformname"><code>platform.name</code></h3>
[Ⓢ](https://github.com/bestiejs/platform.js/blob/1.3.6/platform.js#L1129 "View in source") [Ⓣ][1]
The name of the browser/environment.
<br>
<br>
The list of common browser names include:<br>
"Chrome", "Electron", "Firefox", "Firefox for iOS", "IE",
"Microsoft Edge", "PhantomJS", "Safari", "SeaMonkey", "Silk",
"Opera Mini" and "Opera"
<br>
<br>
Mobile versions of some browsers have "Mobile" appended to their name:<br>
eg. "Chrome Mobile", "Firefox Mobile", "IE Mobile" and "Opera Mobile"
---
<!-- /div -->
<!-- div -->
<h3 id="platformos"><code>platform.os</code></h3>
[Ⓢ](https://github.com/bestiejs/platform.js/blob/1.3.6/platform.js#L1174 "View in source") [Ⓣ][1]
The name of the operating system.
---
<!-- /div -->
<!-- div -->
<h3 id="platformparseuanavigatoruseragent"><code>platform.parse([ua=navigator.userAgent])</code></h3>
[Ⓢ](https://github.com/bestiejs/platform.js/blob/1.3.6/platform.js#L253 "View in source") [Ⓣ][1]
Creates a new platform object.
#### Arguments
1. `[ua=navigator.userAgent]` *(Object|string)*: The user agent string or context object.
#### Returns
*(Object)*: A platform object.
---
<!-- /div -->
<!-- div -->
<h3 id="platformprerelease"><code>platform.prerelease</code></h3>
[Ⓢ](https://github.com/bestiejs/platform.js/blob/1.3.6/platform.js#L1137 "View in source") [Ⓣ][1]
The alpha/beta release indicator.
---
<!-- /div -->
<!-- div -->
<h3 id="platformproduct"><code>platform.product</code></h3>
[Ⓢ](https://github.com/bestiejs/platform.js/blob/1.3.6/platform.js#L1150 "View in source") [Ⓣ][1]
The name of the product hosting the browser.
<br>
<br>
The list of common products include:
<br>
<br>
"BlackBerry", "Galaxy S4", "Lumia", "iPad", "iPod", "iPhone", "Kindle",
"Kindle Fire", "Nexus", "Nook", "PlayBook", "TouchPad" and "Transformer"
---
<!-- /div -->
<!-- div -->
<h3 id="platformtostring"><code>platform.toString()</code></h3>
[Ⓢ](https://github.com/bestiejs/platform.js/blob/1.3.6/platform.js#L622 "View in source") [Ⓣ][1]
Returns `platform.description` when the platform object is coerced to a string.
#### Returns
*(string)*: Returns `platform.description` if available, else an empty string.
---
<!-- /div -->
<!-- div -->
<h3 id="platformua"><code>platform.ua</code></h3>
[Ⓢ](https://github.com/bestiejs/platform.js/blob/1.3.6/platform.js#L1158 "View in source") [Ⓣ][1]
The browser's user agent string.
---
<!-- /div -->
<!-- div -->
<h3 id="platformversion"><code>platform.version</code></h3>
[Ⓢ](https://github.com/bestiejs/platform.js/blob/1.3.6/platform.js#L1166 "View in source") [Ⓣ][1]
The browser/environment version.
---
<!-- /div -->
<!-- /div -->
<!-- div -->
## `platform.os`
<!-- div -->
<h3 id="platformosarchitecture"><code>platform.os.architecture</code></h3>
[Ⓢ](https://github.com/bestiejs/platform.js/blob/1.3.6/platform.js#L1182 "View in source") [Ⓣ][1]
The CPU architecture the OS is built for.
---
<!-- /div -->
<!-- div -->
<h3 id="platformosfamily"><code>platform.os.family</code></h3>
[Ⓢ](https://github.com/bestiejs/platform.js/blob/1.3.6/platform.js#L1195 "View in source") [Ⓣ][1]
The family of the OS.
<br>
<br>
Common values include:<br>
"Windows", "Windows Server `2008` R2 / `7`", "Windows Server `2008` / Vista",
"Windows XP", "OS X", "Linux", "Ubuntu", "Debian", "Fedora", "Red Hat",
"SuSE", "Android", "iOS" and "Windows Phone"
---
<!-- /div -->
<!-- div -->
<h3 id="platformostostring"><code>platform.os.toString()</code></h3>
[Ⓢ](https://github.com/bestiejs/platform.js/blob/1.3.6/platform.js#L1211 "View in source") [Ⓣ][1]
Returns the OS string.
#### Returns
*(string)*: The OS string.
---
<!-- /div -->
<!-- div -->
<h3 id="platformosversion"><code>platform.os.version</code></h3>
[Ⓢ](https://github.com/bestiejs/platform.js/blob/1.3.6/platform.js#L1203 "View in source") [Ⓣ][1]
The version of the OS.
---
<!-- /div -->
<!-- /div -->
<!-- /div -->
[1]: #platform "Jump back to the TOC."
|