X
Statistics
Total Installs
56
Last 24h
+0
User Rating
-
Ad
Description
Versions1
Ratings0
Permissions
纯 JavaScript 编写的通用工具函数库，提供类型检测、文件操作、延时、字符串处理、Cookie 管理等多种实用函
Loading…
XUtils 是一个纯 JavaScript 编写的通用工具函数库，无任何外部依赖。提供了日常开发中常用的工具函数，涵盖类型检测、文件操作、延时控制、字符串处理、Cookie 操作、数值计算、日期温度转换、DOM 操作、数据转换及函数包装等场景。
在油猴脚本或脚本猫中通过 @require 引入：
// ==UserScript==
// @name 我的脚本
// @require https://scriptcat.org/lib/6770/1.0.0/XUtils.js?sha384-Uudf4p/9d0W2IhaoC95ImRHTjcdQKST50ro2T7bPCotjEmhj9lzAYipOAAcFd+sY
// ==/UserScript==
(function () {
'use strict';
// XUtils 作为全局变量可用
XUtils.sleep(1000).then(() => console.log('1秒后'));
})();
通过 <script> 标签引入，XUtils 将挂载为全局变量 window.XUtils：
<script src="XUtils.js"></script>
<script>
XUtils.downloadText('hello.txt', 'Hello World!');
</script>
const XUtils = require('./XUtils.js');
XUtils.average(1, 2, 3, 4); // 2.5
注意：
downloadText、getCookie、setCookie、createScriptElement、removeClassElement等依赖 DOM/BOM 的函数在 Node.js 环境中不可用。
define(['XUtils'], function (XUtils) {
XUtils.reverse('hello'); // 'olleh'
});
// 延时等待
await XUtils.sleep(2000);
// 下载文本文件
XUtils.downloadText('data.csv', XUtils.jsonToCsv([{ name: '张三', age: 25 }]));
// 超时执行异步函数
const result = await XUtils.timeoutFunc(fetchData, 3000);
// Cookie 操作
XUtils.setCookie('token', 'abc123', 7);
const token = XUtils.getCookie('token');
// HTML 编解码
const escaped = XUtils.HTMLEnCode('<div class="box">内容</div>');
const original = XUtils.HTMLDeCode(escaped);
// 一次性函数
const init = XUtils.toOnceFn(() => console.log('只执行一次'));
init(); // 输出日志
init(); // 不再执行
| 方法 | 参数 | 返回值 | 说明 |
|---|---|---|---|
isPromise(o) |
* o — 待检测值 |
boolean |
判断值是否为 Promise 对象，支持原生 Promise 及 WrapperPromise |
isAsyncFunction(o) |
* o — 待检测值 |
boolean |
判断值是否为异步函数（async function） |
XUtils.isPromise(fetch('/api')); // true
XUtils.isPromise(null); // false
XUtils.isAsyncFunction(async () => {}); // true
XUtils.isAsyncFunction(() => {}); // false
| 方法 | 参数 | 返回值 | 说明 |
|---|---|---|---|
downloadText(fileName, content) |
string fileName — 文件名string content — 文件内容 |
无 | 触发浏览器下载文本文件 |
XUtils.downloadText('log.txt', '操作日志内容...');
XUtils.downloadText('data.csv', XUtils.jsonToCsv(data));
| 方法 | 参数 | 返回值 | 说明 |
|---|---|---|---|
sleep(ms) |
number ms — 延时毫秒数 |
Promise<void> |
延时等待，配合 await 使用 |
timeoutFunc(fn, timeout) |
Function fn — 同步或异步函数number timeout — 超时毫秒数（默认 5000） |
Promise<*> |
带超时执行函数，超时则 reject 并抛出 Error('timeout') |
// 延时 1 秒
await XUtils.sleep(1000);
// 带超时执行异步请求（3秒超时）
try {
const data = await XUtils.timeoutFunc(() => fetch('/api').then(r => r.json()), 3000);
} catch (e) {
console.error('请求超时或出错:', e.message);
}
// 带超时执行同步函数
const result = await XUtils.timeoutFunc(() => heavyComputation(), 5000);
| 方法 | 参数 | 返回值 | 说明 |
|---|---|---|---|
contains(s, a) |
string s — 源字符串string a — 子串 |
boolean |
判断源字符串是否包含子串 |
reverse(str) |
string str — 源字符串 |
string |
反转字符串 |
HTMLEnCode(str) |
string str — 源字符串 |
string |
HTML 编码，转义 & < > " 及空格 |
HTMLDeCode(str) |
string str — 源字符串 |
string |
HTML 解码，还原转义字符 |
XUtils.contains('hello world', 'world'); // true
XUtils.contains('hello', 'xyz'); // false
XUtils.reverse('hello'); // 'olleh'
XUtils.HTMLEnCode('<div class="a">'); // '<div class="a">'
XUtils.HTMLDeCode('<div>'); // '<div>'
| 方法 | 参数 | 返回值 | 说明 |
|---|---|---|---|
getCookie(name) |
string name — Cookie 名 |
`string | null` |
setCookie(name, value, expiredays) |
string name — Cookie 名string value — Cookie 值number expiredays — 过期天数（可选） |
无 | 设置 Cookie，可指定过期天数 |
// 设置 Cookie，7 天过期
XUtils.setCookie('theme', 'dark', 7);
// 设置 Cookie，会话结束即失效
XUtils.setCookie('session_id', 'abc123');
// 获取 Cookie
const theme = XUtils.getCookie('theme'); // 'dark'
const none = XUtils.getCookie('notexist'); // null
| 方法 | 参数 | 返回值 | 说明 |
|---|---|---|---|
randomBool() |
无 | boolean |
获取随机布尔值 |
isEven(num) |
number num |
boolean |
判断数字是否为偶数 |
average(...args) |
...number args |
number |
计算所有参数的平均值 |
toFixed(n, fixed) |
number n — 数值number fixed — 小数位数 |
number |
保留小数位（截断方式，非四舍五入） |
XUtils.randomBool(); // true 或 false
XUtils.isEven(4); // true
XUtils.isEven(3); // false
XUtils.average(1, 2, 3, 4); // 2.5
XUtils.toFixed(25.198726, 2); // 25.19（截断，非四舍五入）
XUtils.toFixed(25.198726, 4); // 25.1987
| 方法 | 参数 | 返回值 | 说明 |
|---|---|---|---|
isWeekDay(date) |
Date date |
boolean |
判断日期是否为工作日（周一至周五） |
timeFromDate(date) |
Date date |
string |
从日期中提取时间字符串 HH:MM:SS |
celsiusToFahrenheit(celsius) |
number celsius |
number |
摄氏度转华氏度 |
fahrenheitToCelsius(fahrenheit) |
number fahrenheit |
number |
华氏度转摄氏度 |
XUtils.isWeekDay(new Date(2024, 0, 8)); // true（周一）
XUtils.isWeekDay(new Date(2024, 0, 6)); // false（周六）
XUtils.timeFromDate(new Date(2024, 0, 1, 17, 30, 0)); // '17:30:00'
XUtils.celsiusToFahrenheit(0); // 32
XUtils.celsiusToFahrenheit(100); // 212
XUtils.fahrenheitToCelsius(32); // 0
XUtils.fahrenheitToCelsius(212); // 100
| 方法 | 参数 | 返回值 | 说明 |
|---|---|---|---|
createScriptElement(url, callback) |
string url — 脚本 URLFunction callback — 加载完成回调（可选） |
无 | 动态加载外部 JS 脚本，兼容 IE |
removeClassElement(selectors, once) |
`string | string[] selectors — CSS 选择器或数组<br>boolean once— 仅移除首个匹配（可选，默认false`） |
无 |
// 加载外部脚本
XUtils.createScriptElement('https://cdn.example.com/lib.js', () => {
console.log('脚本加载完成');
});
// 移除所有匹配元素
XUtils.removeClassElement('.ad-banner');
XUtils.removeClassElement(['.ad-banner', '.popup-overlay']);
// 仅移除第一个匹配元素
XUtils.removeClassElement('.notification', true);
| 方法 | 参数 | 返回值 | 说明 |
|---|---|---|---|
jsonToCsv(jsonData) |
Object[] jsonData — 对象数组 |
string |
将 JSON 对象数组转换为 CSV 字符串 |
const data = [
{ name: '张三', age: 25, city: '北京' },
{ name: '李四', age: 30, city: '上海' }
];
const csv = XUtils.jsonToCsv(data);
// "name,age,city\n张三,25,北京\n李四,30,上海\n"
// 配合 downloadText 导出 CSV 文件
XUtils.downloadText('users.csv', csv);
| 方法 | 参数 | 返回值 | 说明 |
|---|---|---|---|
toOnceFn(fn) |
Function fn — 源函数 |
Function |
创建只执行一次的函数包装，第二次调用不再执行 |
// 确保初始化逻辑只执行一次
const init = XUtils.toOnceFn(() => {
console.log('初始化完成');
});
init(); // 输出 "初始化完成"
init(); // 不再执行，返回 undefined
| 浏览器 | 最低版本 |
|---|---|
| Chrome | 60+ |
| Firefox | 55+ |
| Safari | 11+ |
| Edge | 79+ |
| Node.js | 8+ |
注意：依赖 DOM/BOM 的函数（
downloadText、getCookie、setCookie、createScriptElement、removeClassElement）在 Node.js 环境中不可用。其他纯逻辑函数（sleep、isPromise、isAsyncFunction、reverse、average等）可在任何 JavaScript 环境中使用。
| 版本 | 日期 | 说明 |
|---|---|---|
| 1.0.0 | 2023-12-10 | 初始版本，从油猴脚本重构为纯 JS 库 |
MIT License - 详见 LICENSE