@mznjs/helper
v3.1.0
Published
JavaScript 函数库、工具类
Readme
文档采用DeepseekAI大模型自动生成的,仅供参考。
根据提供的 index.d.cts 文件内容,以下是生成的使用文档:
@mznjs/helper 工具库使用文档
1. 核心模块概览
export { db, storage, utils } // 主要导出内容
export { lib, stdEnv, unstorage } // 扩展工具库2. 存储模块 (storage)
2.1 本地存储操作
import { storage } from '@mznjs/helper'
// 设置数据
storage.set('theme', 'dark')
// 获取数据
const theme = storage.get('theme') // 'dark'
// 删除数据
storage.remove('theme')2.2 数据库操作 (unstorage)
import { db } from '@mznjs/helper'
// 设置键值
await db.setItem('cache:data', { timestamp: Date.now() })
// 获取键值
const data = await db.getItem('cache:data')
// 删除键值
await db.removeItem('cache:data')3. 实用工具 (utils)
3.1 Favicon 获取工具
import { utils } from '@mznjs/helper'
// 创建实例
const fetcher = new utils.fav.FaviconFetcher('https://example.com')
// 获取 favicon URL
const url = await fetcher.getFaviconUrl()
// 获取二进制数据
const blob = await fetcher.fetchFavicon()
// 加载为图像
const img = await fetcher.loadFaviconAsImage()3.2 数据验证工具
import { utils } from '@mznjs/helper'
// 手机号验证
utils.testValidate('13800138000', 'mobile') // true
// 邮箱验证
utils.testValidate('[email protected]', 'email') // true
// 支持的全部验证类型:
type ValidationType =
| 'version' // 版本号 (x.y.z)
| 'mobile' // 手机号
| 'email' // 邮箱
| 'ip' // IP地址
| 'url' // URL
| 'datetime' // 日期时间 (YYYY-MM-DD HH:mm:ss)
| 'english+number' // 英文+数字组合
| 'chinese' // 纯中文
// ...共 25 种验证类型3.3 URL 处理工具
import { utils } from '@mznjs/helper'
// URL 解析
const parsed = utils.url.parseUrlWithRegex('https://example.com:8080/path')
/* 返回:
{
protocol: 'https',
hostname: 'example.com',
port: '8080',
path: '/path'
}
*/
// 强制转换为 HTTP
utils.url.http('ftp://example.com') // 'http://example.com'4. 扩展工具库
// 存储增强库 (unstorage)
import { unstorage } from '@mznjs/helper'
// 基础工具库 (@mznjs/library)
import { lib } from '@mznjs/helper'
// 环境检测库 (std-env)
import { stdEnv } from '@mznjs/helper'
lib.crypto.randomUUID()
console.log(stdEnv.isBrowser)5. 类型定义
所有工具均包含完整的 TypeScript 类型定义,支持以下功能:
- 方法参数类型提示
- 返回值类型推断
- 枚举类型自动补全(如
ValidationType) - 类方法智能提示
典型应用场景
- 前端缓存管理:结合
storage和db实现多级缓存 - 表单验证:使用
testValidate进行实时输入校验 - 爬虫开发:利用
FaviconFetcher获取网站图标 - URL 标准化:通过
url工具处理第三方链接 - 环境适配:配合
stdEnv实现跨平台兼容逻辑
完整类型定义可参考 index.d.cts 文件,所有接口均包含中文注释说明。
