Skip to content

docs: add comprehensive README examples for all helpers #7

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
OSMeteor wants to merge 2 commits into
base: master
Choose a base branch
from
Open

docs: add comprehensive README examples for all helpers #7

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e8142d4
docs: document every helper in README usage
OSMeteor Nov 3, 2025
4b5da6c
Merge branch 'master' into codex/add-code-examples-with-chinese-descr…
OSMeteor Nov 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
232 changes: 212 additions & 20 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,23 +12,224 @@ npm install eutil

## Usage

复制以下脚本即可在 Node.js REPL 或任意运行环境中测试所有函数的行为，注释已经用中文说明每个工具的用途。

```javascript
const eutil = require('eutil');

// 常见功能示例，复制即可使用
const { dateFormat, strReplaceAll, isArray } = eutil;
const {
// 异步批量替换
strReplaceAllPromise,
strReplacePromise,

// 日期数值/格式化工具
getTimeSeconds,
getTimeSecondsDate,
dateFormat,
dateGetDataString,
dateGetDataStringNUmber,
dateGetNextDay,
dateGetBeforeDay,
numberLenWithZero,
numberChrW,
isType,
dateAddMilliseconds,
dateAddSeconds,
dateAddMinutes,
dateAddHours,
dateAddDays,
dateIsLeepYear,
dateDaysInMonth,
dateAddMonth,
dateSubMonth,
dateAddYears,
dateDiff,
dateGetCNDate,
dateGetGMT,
dateGetStandardTimeZone,
dateGetDateFromOffset,
dateGetDayOfStart,
dateGetDayOfEnd,
dateGetDayOfDaybreakSection,
dateGetDayOfDaybreakSectionDay,
dateGetDayOfDaybreakSectionDayBefore,
dateGetDayOfDaybreakSectionDayNext,

// 类型判断
isUndefined,
isPromise,
isDefined,
isObject,
isArray,
isString,
isNumber,
isDate,
isFunction,
isRegExp,
isFile,
isFormData,
isBlob,
isBoolean,
isPromiseLike,
arrayRemove,
isJsonObject,
isMap,
haveOwnproperty,
arrayIsexist,

// 字符串处理
strAppend,
strRemoveCharAt,
strRemoveString,
strEndWith,
strEqual,
strEqualIgnoreCase,
strInsert,
strIsAllNumber,
strReserve,
strSetCharAt,
strStartWith,
strCharLength,
strCharLengthReg,
strRepeat,
strIsNumeric,
strResetBlank,
strLTrim,
strRTrim,
strTrim,
strGetEn,
strGetCn,
strGetRealLength,
strSubLeft,
strSubRight,
strToInt,
strGetLen,
strGetFileName,
strGetExtensionName,
strReplaceAll,
strReplaceAll2,
strVerifyuserName,
strIsEmail,
strisMobile,
strVerifyPassword,
strIsInt,
strCloneObj,
strBaseConverter,
strPadstr,
stripScript,
} = eutil;

(async () => {
const now = new Date('2024-06-15T10:20:30Z');

// === 异步批量替换 ===
const replacePlan = [
{ name: '{name}', value: 'Alice' },
{ name: '{lang}', value: '中文' },
];
console.log('Promise 链式批量替换:', await strReplaceAllPromise('Hello {name}, 欢迎使用 {lang}!', replacePlan));
console.log('Promise 封装批量替换:', await strReplacePromise('Dear {name}, 欢迎学习 {lang}.', replacePlan));

// 日期格式化：格式化当前时间为 2024-01-01 08:00:00
const now = new Date();
const formatted = dateFormat(now, 'yyyy-MM-dd hh:mm:ss');
console.log('当前格式化后的时间:', formatted); // 输出类似 2024-01-01 08:00:00
// === 日期工具 ===
console.log('当前秒级时间戳:', getTimeSeconds());
console.log('从秒转换成日期对象:', getTimeSecondsDate(getTimeSeconds()));
console.log('日期格式化:', dateFormat(now, 'yyyy-MM-dd hh:mm:ss'));
console.log('日期字符串 (默认格式):', dateGetDataString(now));
console.log('日期数字格式字符串:', dateGetDataStringNUmber(now));
console.log('未来两天:', dateGetNextDay(now, 2));
console.log('过去三天:', dateGetBeforeDay(now, 3));
console.log('数字补零:', numberLenWithZero(7, 4));
console.log('转换为全角字符:', numberChrW(65313));
const isDateType = isType('Date');
console.log('检测变量类型 (Date):', isDateType(now));
console.log('增加 500 毫秒:', dateAddMilliseconds(now, 500));
console.log('增加 30 秒:', dateAddSeconds(now, 30));
console.log('增加 15 分钟:', dateAddMinutes(now, 15));
console.log('增加 5 小时:', dateAddHours(now, 5));
console.log('增加 7 天:', dateAddDays(now, 7));
console.log('是否闰年:', dateIsLeepYear(2024));
console.log('当月天数:', dateDaysInMonth(now.getFullYear(), now.getMonth() + 1));
console.log('增加 2 个月:', dateAddMonth(now, 2));
console.log('减少 1 个月:', dateSubMonth(now, 1));
console.log('增加 3 年:', dateAddYears(now, 3));
console.log('日期差 (天):', dateDiff(now, dateAddDays(now, 10), 'd'));
console.log('中文日期表示:', dateGetCNDate(now));
console.log('GMT 时间:', dateGetGMT());
console.log('时区 (标准格式):', dateGetStandardTimeZone());
console.log('按偏移获取日期 (UTC+8):', dateGetDateFromOffset(now, 8));
console.log('当天开始:', dateGetDayOfStart(now));
console.log('当天结束:', dateGetDayOfEnd(now));
console.log('当天破晓区间:', dateGetDayOfDaybreakSection(now));
console.log('任意日破晓区间:', dateGetDayOfDaybreakSectionDay(now, 1));
console.log('前一日破晓区间:', dateGetDayOfDaybreakSectionDayBefore(now));
console.log('下一日破晓区间:', dateGetDayOfDaybreakSectionDayNext(now));

// 字符串替换：将字符串中的 - 替换为 #
const replaced = strReplaceAll('a-b-c', '-', '#');
console.log('替换后的字符串:', replaced); // 输出 a#b#c
// === 类型判断 ===
const sampleArray = ['a', 'b'];
console.log('是否未定义:', isUndefined(undefined));
console.log('是否 Promise 对象:', isPromise(Promise.resolve()));
console.log('是否已定义:', isDefined('hello'));
console.log('是否对象:', isObject({ foo: 'bar' }));
console.log('是否数组:', isArray(sampleArray));
console.log('是否字符串:', isString('文本'));
console.log('是否数字:', isNumber(3.14));
console.log('是否日期对象:', isDate(now));
console.log('是否函数:', isFunction(() => {}));
console.log('是否正则表达式:', isRegExp(/abc/));
console.log('是否 File 对象 (示例):', isFile({ [Symbol.toStringTag]: 'File' }));
console.log('是否 FormData 对象:', isFormData({ [Symbol.toStringTag]: 'FormData' }));
console.log('是否 Blob 对象:', isBlob({ [Symbol.toStringTag]: 'Blob' }));
console.log('是否布尔值:', isBoolean(false));
console.log('是否类 Promise:', isPromiseLike({ then: () => {} }));
const removable = ['a', 'b'];
arrayRemove(removable, 'a');
console.log('数组移除元素后:', removable);
console.log('是否 JSON 对象:', isJsonObject({ foo: 'bar' }));
console.log('是否 Map 对象 (通过枚举键判断):', isMap({ key: 'value' }));
console.log('对象是否有自有属性:', haveOwnproperty({ foo: 1 }, 'foo'));
console.log('数组中是否存在值:', arrayIsexist(['Alpha', 'Beta'], 'beta'));

// 类型判断：快速判断一个值是否为数组
console.log('是否为数组:', isArray([1, 2, 3])); // 输出 true
// === 字符串处理 ===
console.log('字符串拼接:', strAppend('Hello', 'World'));
console.log('删除指定下标字符:', strRemoveCharAt('Hello', 1));
console.log('删除指定子串:', strRemoveString('foo_bar_baz', '_bar'));
console.log('是否以指定字符结尾:', strEndWith('example.js', '.js'));
console.log('完全相等比较:', strEqual('ABC', 'ABC'));
console.log('忽略大小写比较:', strEqualIgnoreCase('Hello', 'hello'));
console.log('插入字符串:', strInsert('HelloWorld', 5, ' '));
console.log('是否全为数字字符:', strIsAllNumber('12345'));
console.log('字符串反转:', strReserve('Hello'));
console.log('替换指定位置字符:', strSetCharAt('Hello', 1, 'a'));
console.log('是否以某字符开头:', strStartWith('data.json', 'data'));
console.log('字符长度 (ASCII 计算):', strCharLength('Hello世界'));
console.log('字符长度 (正则匹配):', strCharLengthReg('Hello世界'));
console.log('重复字符串:', strRepeat('na', 4));
console.log('是否数值字符串:', strIsNumeric('123.45'));
console.log('压缩多余空白:', strResetBlank(' foo bar '));
console.log('左侧去空格:', strLTrim(' left'));
console.log('右侧去空格:', strRTrim('right '));
console.log('两端去空格:', strTrim(' trim '));
console.log('提取英文字符:', strGetEn('混合ABC123'));
console.log('提取中文字符:', strGetCn('混合ABC123'));
console.log('实际字符长度 (中文算双字节):', strGetRealLength('Hello世界'));
console.log('左侧截取:', strSubLeft('abcdef', 3));
console.log('右侧截取:', strSubRight('abcdef', 3));
console.log('字符串转整数:', strToInt('42'));
console.log('获取长度 (兼容中文):', strGetLen('Hello世界'));
console.log('获取文件名:', strGetFileName('/path/to/archive.tar.gz'));
console.log('获取扩展名:', strGetExtensionName('archive.tar.gz'));
console.log('替换全部 (字符串):', strReplaceAll('1,2,3', ',', '|'));
console.log('替换全部 (正则):', strReplaceAll2('abc123', '\\d', '#'));
console.log('校验用户名 (5 位数字):', strVerifyuserName('12345'));
console.log('是否邮箱:', strIsEmail('foo@example.com'));
console.log('是否手机号:', strisMobile('13800138000'));
console.log('密码复杂度校验:', strVerifyPassword('Aa123!'));
console.log('是否整数:', strIsInt('42'));
console.log('克隆对象:', strCloneObj({ a: 1, b: { c: 2 } }));
console.log('进制转换:', strBaseConverter('ff', 16, 10));
console.log('字符串补齐:', strPadstr('42', '0', 5));
console.log('过滤脚本标签:', stripScript('<div>Hi<script>alert(1)</script></div>'));
})();
```

## API overview
Expand Down Expand Up @@ -67,15 +268,6 @@ console.log('是否为数组:', isArray([1, 2, 3])); // 输出 true
- `isBoolean(value)` - Check for boolean. **是否为布尔值**
- `isMap(value)` - Check for Map. **是否为 Map**

### Example

```javascript
const eutil = require('eutil');

console.log(eutil.dateFormat(new Date(), 'yyyy-MM-dd hh:mm:ss'));
console.log(eutil.strReplaceAll('a-b-c', '-', '#'));
```

For a full list of helpers see [`index.js`](./index.js).

## License
Expand Down