项目简介
InfoJs 是基于 JavaScript 和 Vite 构建的系统项目,旨在让开发者便捷获取客户端信息。通过简单配置与使用,可获取浏览器信息、设备信息、运行环境等关键数据。
项目的主要特性和功能
- 简单易用:简单配置和导入即可获取丰富客户端信息。
- 高效性能:采用 Vite 构建工具,实现快速开发和热更新。
- 丰富的 API:提供浏览器信息、设备信息、运行环境等多种类型 API,满足不同开发需求。
- 可扩展性:支持自定义插件和扩展,方便个性化定制。
安装使用步骤
一、安装依赖
可通过 npm 或 yarn 安装 InfoJs 库和相关插件:
shell
npm install sudongyu-info-js --save
npm install sudongyu-infojs-plugin --save-dev
或者
shell
yarn add sudongyu-info-js
yarn add sudongyu-infojs-plugin --dev
二、配置 Vite 插件
在 vite.config.js
文件中配置 InfoJs 插件:
```javascript
import infoJsPlugin from 'sudongyu-infojs-plugin'
export default defineConfig({ plugins: [infoJsPlugin()], // 优化包依赖 optimizeDeps: { // 排除插件生成的虚拟路径 exclude: ['@infoJs-plugin-virtual-module'] } }) ```
三、使用 InfoJs
在项目的任意位置使用 InfoJs,仅需导入 'sudongyu-info-js'
:
javascript
import 'sudongyu-info-js' // 仅需在 main.ts 导入即可
完成导入后,所有的信息对象都会被注入到 window
对象上,可直接使用。
API 参考
1. Window 对象
browserInfo
:包含浏览器信息。browserExtension
:包含浏览器扩展信息(可读写)。
2. BrowserInfo 对象(只读)
screenResolution
:客户端浏览器的分辨率。isMobileDevice
:客户端是否为移动设备。userAgent
:客户端浏览器信息。appPackageName
:应用包名。appVersion
:客户端浏览器的平台和版本信息。appVersionCode
:版本号。platform
:客户端运行浏览器的操作系统平台。appIpAddress
:客户端 IP 地址。appIpCountry
:客户端 IP 所在地理位置。appMode
:App 的运行环境。viteMode
:Vite 的运行环境。
更多详细信息可查看项目文档。例如,可以打印浏览器信息到控制台进行测试,查看具体可用属性和方法,如 console.log(window.browserInfo)
。同时,可以使用 window.browserExtension.language
设置或获取浏览器语言包等信息。(其中可写的代表可以主动修改设置,如设置浏览器语言包;可读的代表只能读取数据,不能更改)
该项目将持续开发,后续计划增加浏览器指纹等功能。
下载地址
点击下载 【提取码: 4003】【解压密码: www.makuang.net】