@i17hush/h5-utils 1.0.0

package/dist/index.d.ts

@@ -0,0 +1,356 @@
+/**
+ * 适配器接口定义
+ * 跨端差异化的操作通过适配器抽象，浏览器和 Taro 各自实现
+ */
+interface StorageAdapter {
+    get(key: string): string | null;
+    set(key: string, value: string, options?: StorageSetOptions): void;
+    remove(key: string): void;
+    clear(): void;
+}
+interface StorageSetOptions {
+    /** 过期时间（毫秒） */
+    expires?: number;
+}
+interface ClipboardAdapter {
+    write(text: string): Promise<void>;
+    read(): Promise<string>;
+}
+interface EventEmitterAdapter {
+    on(event: string, handler: (...args: any[]) => void): void;
+    off(event: string, handler: (...args: any[]) => void): void;
+    emit(event: string, ...args: any[]): void;
+}
+interface DomAdapter {
+    select(selector: string): Element | null;
+    selectAll(selector: string): Element[];
+}
+interface ScrollAdapter {
+    /** 滚动到指定位置 */
+    scrollTo(options: {
+        top?: number;
+        left?: number;
+        animated?: boolean;
+    }): void;
+    /** 获取当前滚动位置 */
+    getScrollPosition(): {
+        scrollTop: number;
+        scrollLeft: number;
+    };
+    /** 锁定滚动 */
+    lockScroll(): void;
+    /** 解锁滚动 */
+    unlockScroll(): void;
+}
+interface DeviceInfo {
+    /** 是否 iOS */
+    ios: boolean;
+    /** 是否 Android */
+    android: boolean;
+    /** 是否移动端 */
+    mobile: boolean;
+    /** 是否微信 */
+    weChat: boolean;
+    /** 系统信息 */
+    os: string;
+    /** 品牌 */
+    brand: string;
+    /** 型号 */
+    model: string;
+    /** 屏幕宽度 */
+    screenWidth: number;
+    /** 屏幕高度 */
+    screenHeight: number;
+    /** 像素比 */
+    pixelRatio: number;
+}
+interface DeviceAdapter {
+    /** 获取设备信息 */
+    getInfo(): DeviceInfo;
+    /** 获取网络类型 */
+    getNetworkType(): Promise<string>;
+}
+interface PlatformAdapter {
+    storage: StorageAdapter;
+    clipboard: ClipboardAdapter;
+    event: EventEmitterAdapter;
+    dom: DomAdapter;
+    scroll: ScrollAdapter;
+    device: DeviceAdapter;
+}
+
+/**
+ * 设置平台适配器（如切换到 Taro）
+ */
+declare function setAdapter(adapter: PlatformAdapter): void;
+/**
+ * 获取当前平台适配器
+ */
+declare function getAdapter(): PlatformAdapter;
+
+/**
+ * URL 解析与操作工具
+ */
+interface ParsedUrl {
+    protocol: string;
+    host: string;
+    port: string;
+    pathname: string;
+    search: string;
+    hash: string;
+    query: Record<string, string>;
+}
+/**
+ * 解析 URL 为结构化对象
+ */
+declare function parseUrl(url: string): ParsedUrl;
+/**
+ * 拼接带查询参数的 URL
+ */
+declare function buildUrl(base: string, params: Record<string, string | number | boolean>): string;
+/**
+ * 获取当前页面指定查询参数
+ */
+declare function getQueryParam(name: string): string | null;
+/**
+ * 获取当前页面所有查询参数
+ */
+declare function getAllQueryParams(): Record<string, string>;
+
+/**
+ * Storage 封装
+ * 支持过期时间、JSON 自动序列化
+ * 通过适配器支持跨端
+ */
+
+/**
+ * 获取存储值，支持 JSON 自动反序列化
+ */
+declare function get$1<T = unknown>(key: string): T | null;
+/**
+ * 设置存储值，支持过期时间
+ */
+declare function set$1(key: string, value: unknown, options?: StorageSetOptions): void;
+/**
+ * 删除存储值
+ */
+declare function remove$1(key: string): void;
+/**
+ * 清空所有存储
+ */
+declare function clear(): void;
+
+/**
+ * Cookie 读写删工具
+ */
+interface CookieOptions {
+    /** 过期天数 */
+    days?: number;
+    /** 域名 */
+    domain?: string;
+    /** 路径 */
+    path?: string;
+    /** 仅 HTTPS */
+    secure?: boolean;
+    /** SameSite 策略 */
+    sameSite?: 'strict' | 'lax' | 'none';
+}
+/**
+ * 获取 Cookie 值
+ */
+declare function get(name: string): string | null;
+/**
+ * 设置 Cookie
+ */
+declare function set(name: string, value: string, options?: CookieOptions): void;
+/**
+ * 删除 Cookie
+ */
+declare function remove(name: string, options?: CookieOptions): void;
+
+/**
+ * 设备/浏览器检测工具
+ */
+/**
+ * 是否为 iOS
+ */
+declare function isIOS(): boolean;
+/**
+ * 是否为 Android
+ */
+declare function isAndroid(): boolean;
+/**
+ * 是否为微信浏览器
+ */
+declare function isWeChat(): boolean;
+/**
+ * 是否为移动端
+ */
+declare function isMobile(): boolean;
+type BrowserType = 'weixin' | 'qq' | 'uc' | 'safari' | 'chrome' | 'firefox' | 'edge' | 'ie' | 'unknown';
+/**
+ * 获取浏览器类型（H5 专用）
+ */
+declare function getBrowserType(): BrowserType;
+/**
+ * 获取操作系统信息
+ */
+declare function getOS(): string;
+/**
+ * 获取完整设备信息
+ */
+declare function getDeviceInfo(): DeviceInfo;
+
+/**
+ * DOM 操作工具
+ */
+/**
+ * 查询单个元素
+ */
+declare function $<T extends Element = Element>(selector: string): T | null;
+/**
+ * 查询多个元素
+ */
+declare function $$<T extends Element = Element>(selector: string): T[];
+/**
+ * 添加 class
+ */
+declare function addClass(el: Element, cls: string): void;
+/**
+ * 移除 class
+ */
+declare function removeClass(el: Element, cls: string): void;
+/**
+ * 切换 class
+ */
+declare function toggleClass(el: Element, cls: string): void;
+/**
+ * 判断是否包含 class
+ */
+declare function hasClass(el: Element, cls: string): boolean;
+/**
+ * 获取元素样式
+ */
+declare function getStyle(el: Element, prop: string): string;
+/**
+ * 判断元素是否在可视区域内
+ */
+declare function isInViewport(el: Element): boolean;
+
+/**
+ * 事件工具
+ */
+/**
+ * 绑定事件
+ */
+declare function on(el: EventTarget, event: string, handler: EventListener, options?: AddEventListenerOptions): void;
+/**
+ * 解绑事件
+ */
+declare function off(el: EventTarget, event: string, handler: EventListener, options?: EventListenerOptions): void;
+/**
+ * 单次监听事件
+ */
+declare function once(el: EventTarget, event: string, handler: EventListener): void;
+/**
+ * 事件委托
+ * @param parent 父容器
+ * @param selector 子元素选择器
+ * @param event 事件名
+ * @param handler 回调函数
+ */
+declare function delegate(parent: EventTarget, selector: string, event: string, handler: (el: Element, e: Event) => void): void;
+
+/**
+ * 剪贴板操作
+ */
+/**
+ * 复制文本到剪贴板
+ */
+declare function copyText(text: string): Promise<void>;
+/**
+ * 读取剪贴板文本
+ */
+declare function readText(): Promise<string>;
+
+/**
+ * 滚动相关工具
+ */
+/**
+ * 滚动到页面顶部
+ */
+declare function scrollToTop(smooth?: boolean): void;
+/**
+ * 滚动到指定元素
+ */
+declare function scrollToElement(el: Element, options?: {
+    offset?: number;
+    smooth?: boolean;
+}): void;
+/**
+ * 锁定页面滚动
+ */
+declare function lockScroll(): void;
+/**
+ * 解锁页面滚动
+ */
+declare function unlockScroll(): void;
+
+/**
+ * 格式化工具
+ */
+/**
+ * 日期格式化
+ * @example formatDate(new Date(), 'YYYY-MM-DD HH:mm:ss')
+ */
+declare function formatDate(date: Date | number | string, fmt?: string): string;
+/**
+ * 数字格式化（千分位等）
+ */
+declare function formatNumber(num: number, options?: {
+    precision?: number;
+    separator?: string;
+}): string;
+/**
+ * 手机号格式化 (xxx xxxx xxxx)
+ */
+declare function formatPhone(phone: string): string;
+/**
+ * 金额格式化
+ */
+declare function formatMoney(amount: number, precision?: number): string;
+/**
+ * 节流
+ */
+declare function throttle<T extends (...args: any[]) => any>(fn: T, delay: number): T;
+/**
+ * 防抖
+ */
+declare function debounce<T extends (...args: any[]) => any>(fn: T, delay: number): T;
+
+/**
+ * 校验器工具
+ */
+/**
+ * 手机号格式校验
+ */
+declare function isMobilePhone(str: string): boolean;
+/**
+ * 邮箱校验
+ */
+declare function isEmail(str: string): boolean;
+/**
+ * 身份证号校验（18位）
+ */
+declare function isIdCard(str: string): boolean;
+/**
+ * URL 校验
+ */
+declare function isUrl(str: string): boolean;
+/**
+ * 中文校验
+ */
+declare function isChinese(str: string): boolean;
+
+export { $, $$, addClass, buildUrl, clear as clearStorage, copyText, debounce, delegate, formatDate, formatMoney, formatNumber, formatPhone, getAdapter, getAllQueryParams, getBrowserType, get as getCookie, getDeviceInfo, getOS, getQueryParam, get$1 as getStorage, getStyle, hasClass, isAndroid, isChinese, isEmail, isIOS, isIdCard, isInViewport, isMobile, isMobilePhone, isUrl, isWeChat, lockScroll, off, on, once, parseUrl, readText, removeClass, remove as removeCookie, remove$1 as removeStorage, scrollToElement, scrollToTop, setAdapter, set as setCookie, set$1 as setStorage, throttle, toggleClass, unlockScroll };
+export type { BrowserType, ClipboardAdapter, CookieOptions, DeviceAdapter, DeviceInfo, DomAdapter, EventEmitterAdapter, ParsedUrl, PlatformAdapter, ScrollAdapter, StorageAdapter, StorageSetOptions };