pen-it 1.0.0

package/dist/is/index.d.ts

@@ -0,0 +1,286 @@
+/**
+ * 判断一个值是否为数组
+ * @param value - 要判断的值
+ * @returns 如果是数组返回 true，否则返回 false
+ * @example
+ * isArray([1, 2, 3])
+ * // => true
+ * isArray("hello")
+ * // => false
+ */
+export declare const isArray: (value: any) => boolean;
+/**
+ * 判断一个值是否为对象（但不是数组）
+ * @param value - 要判断的值
+ * @returns 如果是对象且不是数组返回 true，否则返回 false
+ * @example
+ * isObject({ a: 1 })
+ * // => true
+ * isObject([1, 2])
+ * // => false
+ */
+export declare const isObject: (value: any) => boolean;
+/**
+ * 判断数据类型（内部工具函数）
+ * @param val - 要判断的数据
+ * @param type - 数据类型字符串，如 "Array"、"Function"
+ * @returns 如果数据是指定类型返回 true
+ * @example
+ * is([], "Array")
+ * // => true
+ */
+export declare const is: (val: unknown, type: string) => boolean;
+/**
+ * 判断一个值是否为函数
+ * @param val - 要判断的数据
+ * @returns 如果是函数返回 true
+ * @example
+ * isFunction(() => {})
+ * // => true
+ */
+export declare const isFunction: (val: any) => val is Function;
+/**
+ * 判断一个值是否为 Date 对象
+ * @param val - 要判断的数据
+ * @returns 如果是 Date 对象返回 true
+ * @example
+ * isDate(new Date())
+ * // => true
+ */
+export declare const isDate: (val: any) => val is Date;
+/**
+ * 判断一个值是否为数字（NaN 和 Infinity 也视为数字）
+ * @param val - 要判断的数据
+ * @returns 如果是数字返回 true
+ * @example
+ * isNumber(42)
+ * // => true
+ * isNumber("42")
+ * // => false
+ */
+export declare const isNumber: (val: any) => val is number;
+/**
+ * 判断一个值是否为整数
+ * @param val - 要判断的数据
+ * @returns 如果是整数返回 true
+ * @example
+ * isInt(42)
+ * // => true
+ * isInt(3.14)
+ * // => false
+ */
+export declare const isInt: (val: any) => val is number;
+/**
+ * 判断一个值是否为浮点数（有限小数）
+ * @param val - 要判断的数据
+ * @returns 如果是浮点数返回 true
+ * @example
+ * isFloat(3.14)
+ * // => true
+ * isFloat(42)
+ * // => false
+ */
+export declare const isFloat: (val: any) => val is number;
+/**
+ * 判断一个值是否为异步函数
+ * @param val - 要判断的数据
+ * @returns 如果是异步函数返回 true
+ * @example
+ * isAsyncFunction(async () => {})
+ * // => true
+ */
+export declare const isAsyncFunction: (val: unknown) => val is (...args: any[]) => Promise<any>;
+/**
+ * 判断一个值是否为 Promise
+ * @param value - 要判断的数据
+ * @returns 如果是 Promise 返回 true
+ * @example
+ * isPromise(Promise.resolve())
+ * // => true
+ */
+export declare const isPromise: (value: any) => value is Promise<any>;
+/**
+ * 判断一个值是否为字符串
+ * @param val - 要判断的数据
+ * @returns 如果是字符串返回 true
+ * @example
+ * isString("hello")
+ * // => true
+ * isString(42)
+ * // => false
+ */
+export declare const isString: (val: unknown) => val is string;
+/**
+ * 判断一个值是否为布尔值
+ * @param val - 要判断的数据
+ * @returns 如果是布尔值返回 true
+ * @example
+ * isBoolean(true)
+ * // => true
+ * isBoolean(1)
+ * // => false
+ */
+export declare const isBoolean: (val: unknown) => val is boolean;
+/**
+ * 判断是否为 PC 端（浏览器环境）
+ * @returns 如果在浏览器环境中返回 true
+ * @example
+ * isPC()
+ * // => true（在浏览器中）
+ */
+export declare const isPC: () => boolean;
+/**
+ * 判断一个值是否为 window 对象
+ * @param val - 要判断的数据
+ * @returns 如果是 window 对象返回 true
+ * @example
+ * isWindow(window)
+ * // => true（在浏览器中）
+ */
+export declare const isWindow: (val: any) => val is Window;
+/**
+ * 判断一个值是否为 DOM 元素
+ * @param val - 要判断的数据
+ * @returns 如果是 DOM 元素返回 true
+ * @example
+ * isElement(document.body)
+ * // => true
+ */
+export declare const isElement: (val: unknown) => val is Element;
+/**
+ * 判断一个值是否为 null
+ * @param val - 要判断的数据
+ * @returns 如果是 null 返回 true
+ * @example
+ * isNull(null)
+ * // => true
+ */
+export declare const isNull: (val: unknown) => val is null;
+/**
+ * 判断一个值是否为十六进制颜色
+ * @param str - 要判断的字符串
+ * @returns 如果是有效的十六进制颜色值返回 true
+ * @example
+ * isHexColor("#fff")
+ * // => true
+ * isHexColor("#ff0000")
+ * // => true
+ */
+export declare const isHexColor: (str: string) => boolean;
+/**
+ * 判断设备是否为 iOS
+ * @returns 如果是 iOS 设备返回 true
+ * @example
+ * isIOS()
+ * // => true（在 iPhone/iPad 上）
+ */
+export declare const isIOS: () => boolean;
+/**
+ * 判断一个值是否为有效的电子邮件
+ * @param email - 要判断的字符串
+ * @returns 如果是有效的电子邮件地址返回 true
+ * @example
+ * isValidEmail("test@example.com")
+ * // => true
+ */
+export declare const isValidEmail: (email: string) => boolean;
+/**
+ * 判断一个值是否已定义（不是 undefined）
+ * @param val - 要判断的数据
+ * @returns 如果不是 undefined 返回 true
+ * @example
+ * isDef("hello")
+ * // => true
+ * isDef(undefined)
+ * // => false
+ */
+export declare const isDef: <T>(val: T | undefined) => val is T;
+/**
+ * 判断一个值是否为 undefined
+ * @param val - 要判断的数据
+ * @returns 如果是 undefined 返回 true
+ * @example
+ * isUnDef(undefined)
+ * // => true
+ */
+export declare const isUnDef: <T>(val: T | undefined) => val is undefined;
+/**
+ * 判断一个值是否为 null 或 undefined
+ * @param val - 要判断的数据
+ * @returns 如果是 null 或 undefined 返回 true
+ * @example
+ * isNullOrUnDef(null)
+ * // => true
+ * isNullOrUnDef(undefined)
+ * // => true
+ * isNullOrUnDef("hello")
+ * // => false
+ */
+export declare const isNullOrUnDef: <T>(val: T | null | undefined) => val is null | undefined;
+/**
+ * 判断一个值是否为 symbol
+ * @param value - 要判断的数据
+ * @returns 如果是 symbol 返回 true
+ * @example
+ * isSymbol(Symbol("foo"))
+ * // => true
+ */
+export declare const isSymbol: (value: any) => value is symbol;
+/**
+ * 判断一个值是否为原始类型
+ * 原始类型包括：number、string、boolean、symbol、bigint、undefined、null
+ * @param value - 要判断的值
+ * @returns 如果是原始类型返回 true
+ * @example
+ * isPrimitive(42)
+ * // => true
+ * isPrimitive({})
+ * // => false
+ */
+export declare const isPrimitive: (value: any) => boolean;
+/**
+ * 判断一个值是否为空
+ * 空值包括：null、undefined、空字符串、空数组、空对象、空 Map/Set、无效 Date
+ * @param value - 要判断的数据
+ * @returns 如果为空返回 true
+ * @example
+ * isEmpty("")
+ * // => true
+ * isEmpty([])
+ * // => true
+ * isEmpty(0)
+ * // => false
+ */
+export declare const isEmpty: (value: any) => boolean;
+/**
+ * 判断一个值是否为空（简化版）
+ * 支持：字符串、数组、对象、Map、Set、类型化数组
+ * @param value - 要检查的值
+ * @returns 如果为空返回 true
+ * @example
+ * isEmptySv("")
+ * // => true
+ * isEmptySv(null)
+ * // => true
+ * isEmptySv([])
+ * // => true
+ * isEmptySv({})
+ * // => true
+ * isEmptySv(new Set())
+ * // => true
+ * isEmptySv(new Map())
+ * // => true
+ */
+export declare function isEmptySv(value: string | object | null | undefined): boolean;
+/**
+ * 判断两个值是否深度相等
+ * @param x - 要比较的第一个值
+ * @param y - 要比较的第二个值
+ * @returns 如果值深度相等返回 true
+ * @example
+ * isEqual({ a: 1 }, { a: 1 })
+ * // => true
+ * isEqual({ a: 1 }, { a: 2 })
+ * // => false
+ */
+export declare const isEqual: <T>(x: T, y: T) => boolean;

package/dist/storage/index.d.ts

@@ -0,0 +1,30 @@
+/**
+ * 获取 localStorage
+ * @param key - 存储键名
+ * @returns 解析后的值，解析失败则返回原始字符串，键不存在返回 null
+ * @example
+ * localGet("user")
+ * // => { name: "张三" }
+ */
+export declare const localGet: <T = any>(key: string) => T | null;
+/**
+ * 设置 localStorage
+ * @param key - 存储键名
+ * @param value - 存储值（会自动 JSON 序列化）
+ * @example
+ * localSet("user", { name: "张三" })
+ */
+export declare const localSet: (key: string, value: unknown) => void;
+/**
+ * 移除指定 localStorage
+ * @param key - 存储键名
+ * @example
+ * localRm("user")
+ */
+export declare const localRm: (key: string) => void;
+/**
+ * 清除所有 localStorage
+ * @example
+ * localClear()
+ */
+export declare const localClear: () => void;

package/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "pen-it",
+  "version": "1.0.0",
+  "description": "用笔锚定记忆中的前端常用工具函数",
+  "type": "module",
+  "main": "dist/index.cjs",
+  "module": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "scripts": {
+    "build": "rimraf dist && rolldown -c rolldown.config.js",
+    "test": "vitest"
+  },
+  "files": [
+    "dist"
+  ],
+  "keywords": [
+    "utils",
+    "pen-it",
+    "toolkit",
+    "helpers"
+  ],
+  "author": "newborn_calf",
+  "license": "MIT",
+  "packageManager": "pnpm@10.19.0",
+  "devDependencies": {
+    "@rollup/plugin-typescript": "^12.3.0",
+    "@vitest/coverage-v8": "^4.1.8",
+    "jsdom": "^29.1.1",
+    "rimraf": "^6.1.3",
+    "rolldown": "^1.0.3",
+    "tslib": "^2.8.1",
+    "typescript": "^6.0.3",
+    "vitest": "^4.1.8"
+  }
+}