Platform.js 技术文档

1. 安装指南

浏览器环境

在HTML文件中直接引入platform.js文件：

<script src="platform.js"></script>

AMD 模块加载器

在使用AMD模块加载器时，可以通过以下方式引入：

require(['platform'], function(platform) {/*…*/});

npm 安装

通过npm安装platform.js：

$ npm i --save platform

Node.js 环境

在Node.js环境中，可以通过以下方式引入：

var platform = require('platform');

2. 项目的使用说明

基本用法

platform.js是一个平台检测库，能够检测当前运行环境的浏览器、操作系统、设备等信息。以下是一些基本的使用示例：

示例1：检测IE10

// 在IE10 x86平台预览版中运行，且处于IE7兼容模式，操作系统为Windows 7 64位版
platform.name; // 'IE'
platform.version; // '10.0'
platform.layout; // 'Trident'
platform.os; // 'Windows Server 2008 R2 / 7 x64'
platform.description; // 'IE 10.0 x86 (platform preview; running in IE 7 mode) on Windows Server 2008 R2 / 7 x64'

示例2：检测iPad

// 在iPad上运行
platform.name; // 'Safari'
platform.version; // '5.1'
platform.product; // 'iPad'
platform.manufacturer; // 'Apple'
platform.layout; // 'WebKit'
platform.os; // 'iOS 5.0'
platform.description; // 'Safari 5.1 on Apple iPad (iOS 5.0)'

示例3：解析UA字符串

// 解析给定的UA字符串
var info = platform.parse('Mozilla/5.0 (Macintosh; Intel Mac OS X 10.7.2; en; rv:2.0) Gecko/20100101 Firefox/4.0 Opera 11.52');
info.name; // 'Opera'
info.version; // '11.52'
info.layout; // 'Presto'
info.os; // 'Mac OS X 10.7.2'
info.description; // 'Opera 11.52 (identifying as Firefox 4.0) on Mac OS X 10.7.2'

3. 项目API使用文档

platform 对象

platform对象提供了多个属性，用于获取当前运行环境的相关信息：

• platform.name: 返回浏览器名称（如'Chrome', 'Firefox', 'IE'等）。
• platform.version: 返回浏览器版本号。
• platform.layout: 返回浏览器使用的布局引擎（如'WebKit', 'Trident'等）。
• platform.os: 返回操作系统信息。
• platform.description: 返回当前环境的详细描述。
• platform.product: 返回设备类型（如'iPad', 'iPhone'等）。
• platform.manufacturer: 返回设备制造商（如'Apple', 'Samsung'等）。

platform.parse(uaString)

platform.parse方法用于解析给定的用户代理字符串（UA String），并返回一个包含解析结果的对象。

• uaString: 需要解析的用户代理字符串。

返回的对象包含与platform对象相同的属性，用于描述解析后的环境信息。

4. 项目安装方式

浏览器环境

直接在HTML文件中引入platform.js文件：

<script src="platform.js"></script>

AMD 模块加载器

通过AMD模块加载器引入：

require(['platform'], function(platform) {/*…*/});

npm 安装

使用npm安装：

$ npm i --save platform

Node.js 环境

在Node.js中引入：

var platform = require('platform');

通过以上方式，您可以在不同的环境中使用platform.js来检测当前的运行平台信息。