@base-web-kits/base-tools-ts 0.0.3 → 0.0.5

package/README.md

@@ -1,3 +1,32 @@
-# @base-web-kits/base-tools-ts
+# Base Tools
 
-薄包装分包，转发到主包的 `ts` 子路径：`@base-web-kits/base-tools/ts`。
+web前端团队常用工具库，包含`ts`、`web`、`react`、`vue`、`uni`模块。
+
+**安装**
+
+用哪个模块就安装哪个,模块之间不会相互依赖
+
+- `npm i @base-web-kits/base-tools-ts`
+- `npm i @base-web-kits/base-tools-web`
+- `npm i @base-web-kits/base-tools-react`
+- `npm i @base-web-kits/base-tools-vue`
+- `npm i @base-web-kits/base-tools-uni`
+
+**快速使用**
+
+```ts
+// 通用 TS 模块
+import { toDayjs, getUrlParam, toMaskPhone } from '@base-web-kits/base-tools-ts';
+
+// Web 模块
+import { copyText, isPC, download, setCookie } from '@base-web-kits/base-tools-web';
+
+// React 模块
+import { useCountDown } from '@base-web-kits/base-tools-react';
+
+// Vue 模块
+import { useResizeObserver } from '@base-web-kits/base-tools-vue';
+
+// Uni 模块
+import { chooseMedia, toPayWx } from '@base-web-kits/base-tools-uni';
+```

package/dist/array/index.d.ts

@@ -0,0 +1,9 @@
+/**
+ * 拖拽排序 (不改变原数组)
+ * @param list 原始数组
+ * @param fromIndex 要移动的元素的原始索引
+ * @param toIndex 要移动到的目标索引
+ * @returns 移动元素后的新数组
+ */
+export declare function arrayMove<T>(list: T[], fromIndex: number, toIndex: number): T[];
+//# sourceMappingURL=index.d.ts.map

package/dist/array/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/ts/array/index.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,wBAAgB,SAAS,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,EAAE,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,OAKzE"}

package/dist/async/index.d.ts

@@ -0,0 +1,14 @@
+/**
+ * 将 Promise 包装为 [data, error] 形式, 减少 try-catch 代码量
+ * @param p 要包装的 Promise
+ * @returns 一个 Promise，其结果为 [data, error] 形式
+ * @example
+ * const [data, err] = await toAsync(fetch('https://api.example.com/data'));
+ * if (err) {
+ *   console.error(err);
+ *   return;
+ * }
+ * console.log(data);
+ */
+export declare function toAsync<T>(p: Promise<T>): Promise<[T | null, unknown]>;
+//# sourceMappingURL=index.d.ts.map

package/dist/async/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/ts/async/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AACH,wBAAsB,OAAO,CAAC,CAAC,EAAE,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,GAAG,IAAI,EAAE,OAAO,CAAC,CAAC,CAO5E"}

package/dist/bean/EventBus.d.ts

@@ -0,0 +1,30 @@
+type EventFn = (...args: unknown[]) => void;
+/**
+ * 总线式发布订阅
+ * @example
+ * const em = new EventBus(); // 支持链式调用
+ * em.on('xx', fn); // 订阅事件 xx
+ * em.once('xx', fn); // 订阅事件 xx 一次
+ * em.emit('xx', any); // 发布事件 xx，参数任意
+ * em.off('xx'); // 移除事件 xx 下全部监听
+ * em.off('xx', fn); // 移除事件 xx 下指定监听
+ * em.clear(); // 移除所有事件
+ */
+export default class EventBus {
+    /** 事件池 */
+    private _events;
+    /** 订阅（每次 emit 都触发） */
+    on(type: string, fn: EventFn): this;
+    /** 订阅一次 */
+    once(type: string, fn: EventFn): this;
+    /** 发布事件 */
+    emit(type: string, ...args: unknown[]): boolean;
+    /** 移除指定监听；若 fn 不传，则移除该事件下全部监听 */
+    off(type: string, fn?: EventFn): this;
+    /** 清空所有事件 */
+    clear(): this;
+    /** 当前已注册的事件名列表 */
+    eventNames(): string[];
+}
+export {};
+//# sourceMappingURL=EventBus.d.ts.map

package/dist/bean/EventBus.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"EventBus.d.ts","sourceRoot":"","sources":["../../../src/ts/bean/EventBus.ts"],"names":[],"mappings":"AAAA,KAAK,OAAO,GAAG,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,IAAI,CAAC;AAE5C;;;;;;;;;;GAUG;AACH,MAAM,CAAC,OAAO,OAAO,QAAQ;IAC3B,UAAU;IACV,OAAO,CAAC,OAAO,CAAkD;IAEjE,sBAAsB;IACtB,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,OAAO,GAAG,IAAI;IAQnC,WAAW;IACX,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,OAAO,GAAG,IAAI;IAWrC,WAAW;IACX,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,OAAO;IAQ/C,iCAAiC;IACjC,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,CAAC,EAAE,OAAO,GAAG,IAAI;IAcrC,aAAa;IACb,KAAK,IAAI,IAAI;IAKb,kBAAkB;IAClB,UAAU,IAAI,MAAM,EAAE;CAGvB"}

package/dist/bean/index.d.ts

@@ -0,0 +1,2 @@
+export * from './EventBus';
+//# sourceMappingURL=index.d.ts.map

package/dist/bean/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/ts/bean/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC"}

package/dist/day/index.d.ts

@@ -0,0 +1,100 @@
+import dayjs from 'dayjs';
+import 'dayjs/locale/zh-cn';
+type BaseTime = number | string | Date | dayjs.Dayjs | null | undefined;
+/**
+ * 创建 dayjs 实例
+ * 文档: https://day.js.org/zh-CN/
+ * @param t 各种规范或不规范的时间
+ * @returns dayjs 实例
+ * @example
+ * const d = toDayjs('2021-01-01'); // dayjs 实例
+ * d.format('YYYY-MM-DD HH:mm:ss'); // "2025-12-10 11:33:16"
+ * d.valueOf(); // 毫秒时间戳，如 1765337596913
+ * d.unix(); // 秒时间戳，如 1765337596
+ * d.millisecond(); // 毫秒 913
+ * d.second(); // 秒 16
+ * d.minute(); // 分 33
+ * d.hour(); // 时 11
+ * d.date(); // 日 10
+ * d.day(); // 星期几 5（周日=0）
+ * d.month() + 1; // 月 12
+ * d.year(); // 年 2025
+ * d.startOf('day').valueOf(); // 当日零点
+ * d.startOf('month').format('YYYY-MM-DD HH:mm:ss'); // 月初 "2025-12-01 00:00:00"
+ * d.endOf('month').format('YYYY-MM-DD HH:mm:ss'); // 月末 "2025-12-31 23:59:59"
+ * d.fromNow(); // 相对时间文案: “刚刚”、“x分钟前/后”、“x小时前/后”、“x天前/后”、“x月前/后”、“x年前/后”
+ * d.isSame(t, 'day'); // 是否与t在同一天
+ * d.diff(); // 与当前时间相差的毫秒数
+ * d.diff(t); // 与t相差的毫秒数
+ * d.diff(t, 'second'); // 与t相差的秒数
+ * d.diff(t, 'minute'); // 与t相差的分钟数
+ * d.diff(t, 'hour'); // 与t相差的小时数
+ * d.diff(t, 'day'); // 与t相差的天数
+ * d.diff(t, 'week'); // 与t相差的周数
+ * d.diff(t, 'month'); // 与t相差的月数
+ * d.diff(t, 'quarter'); // 与t相差的季度数
+ * d.diff(t, 'year'); // 与t相差的年数
+ */
+export declare function toDayjs(t: BaseTime, fmt?: dayjs.OptionType): dayjs.Dayjs;
+/**
+ * 获取“前几天”的日期范围
+ * @param offset 正整数天数
+ * @param fmt 日期格式，默认 `YYYY-MM-DD`
+ * @returns `[start, end]` 日期字符串数组
+ * @example
+ * 若今天为 2025-11-19：
+ * getDateRangeBefore(1) // ['2025-11-18', '2025-11-19']
+ * getDateRangeBefore(1, 'YYYY-MM-DD HH:mm:ss') // ['2025-11-18 00:00:00', '2025-11-19 23:59:59']
+ */
+export declare function getDateRangeBefore(offset: number, fmt?: string): string[];
+/**
+ * 获取“后几天”的日期范围
+ * - 起点：今天；终点：`offset` 天后
+ * - 若 `fmt` 含时间令牌（如 `HH:mm:ss`），则返回整日范围：起点为当日零点，终点为当日末尾
+ * @param offset 正整数天数
+ * @param fmt 日期格式，默认 `YYYY-MM-DD`
+ * @returns `[start, end]` 日期字符串数组
+ * @example
+ * 若今天为 2025-11-19：
+ * getDateRangeAfter(1) // ['2025-11-19', '2025-11-20']
+ * getDateRangeAfter(1, 'YYYY-MM-DD HH:mm:ss') // ['2025-11-19 00:00:00', '2025-11-20 23:59:59']
+ */
+export declare function getDateRangeAfter(offset: number, fmt?: string): string[];
+/**
+ * 获取倒计时的时间分解（零填充字符串）
+ * @param diff 毫秒差值（正数表示剩余时间，负数/0表示已到期）
+ * @returns 包含天、时、分、秒、毫秒的零填充对象
+ * @example
+ * const diff = toDayjs(t).diff(); // 毫秒差值
+ * const parts = getCountdownParts(diff); // { d: '01', h: '02', m: '03', s: '04', ms: '567' }
+ */
+export declare function getCountdownParts(diff: number): {
+    d: string;
+    h: string;
+    m: string;
+    s: string;
+    ms: string;
+};
+/**
+ * 通过出生日期计算年龄
+ * @param birthdate 生日日期，支持多种格式（会被自动解析）
+ * @returns 年龄对象，包含 `age`（年龄数值）和 `type`（年龄单位，'year' 表示年，'month' 表示月）
+ * @example
+ * // 假设当前日期为 2025-11-19
+ * getAgeByBirthdate('2025-05-10'); // { age: 6, type: 'month' }
+ * getAgeByBirthdate('2020-11-19'); // { age: 5, type: 'year' }
+ * getAgeByBirthdate('2020-12-01'); // { age: 4, type: 'year' }（生日还没到, 所以年龄是4岁）
+ */
+export declare function getAgeByBirthdate(birthdate: string): {
+    age: number;
+    type: string;
+};
+/**
+ * 对外抛出 dayjs 以便全局配置
+ * @example
+ * 切换语言
+ * dayjs.locale('en'); // 切换为英文
+ * dayjs.locale('zh-cn'); // 切换为中文 (默认)
+ */
+export { dayjs };
+//# sourceMappingURL=index.d.ts.map

package/dist/day/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/ts/day/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAM1B,OAAO,oBAAoB,CAAC;AAU5B,KAAK,QAAQ,GAAG,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,KAAK,CAAC,KAAK,GAAG,IAAI,GAAG,SAAS,CAAC;AAExE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,wBAAgB,OAAO,CAAC,CAAC,EAAE,QAAQ,EAAE,GAAG,CAAC,EAAE,KAAK,CAAC,UAAU,eAmB1D;AAED;;;;;;;;;GASG;AACH,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,SAAe,YASpE;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,SAAe,YASnE;AAED;;;;;;;GAOG;AACH,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,MAAM;;;;;;EAgB7C;AAED;;;;;;;;;GASG;AACH,wBAAgB,iBAAiB,CAAC,SAAS,EAAE,MAAM;;;EAqBlD;AAED;;;;;;GAMG;AACH,OAAO,EAAE,KAAK,EAAE,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,15 @@
+/**
+ * 内部统一导出, 外部快捷引入: import {xx} from 'base-tools/ts'
+ */
+export * from './array';
+export * from './async';
+export * from './bean';
+export * from './day';
+export * from './lodash';
+export * from './number';
+export * from './object';
+export * from './string';
+export * from './typing';
+export * from './url';
+export * from './validator';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/ts/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,cAAc,SAAS,CAAC;AACxB,cAAc,SAAS,CAAC;AACxB,cAAc,QAAQ,CAAC;AACvB,cAAc,OAAO,CAAC;AACtB,cAAc,UAAU,CAAC;AACzB,cAAc,UAAU,CAAC;AACzB,cAAc,UAAU,CAAC;AACzB,cAAc,UAAU,CAAC;AACzB,cAAc,UAAU,CAAC;AACzB,cAAc,OAAO,CAAC;AACtB,cAAc,aAAa,CAAC"}