@spacego/turbo-utils 0.0.1-alpha

package/lib/types/validator/validate.d.ts

@@ -0,0 +1,46 @@
+import { validateType } from './validator';
+/**
+ * 校验规则
+ */
+export type TRules<T = Record<any, any>> = {
+    key: keyof T;
+    msg: string;
+    type?: keyof typeof validateType;
+    len?: number;
+};
+/**
+ * form 表单校验规则  默认必传
+ * @param rules 规则
+ * @param data 已填写的数据
+ * @returns valid 是否通过校验, msg 错误信息
+ * @example validate([{ key: 'name', msg: '请输入姓名', type: 'required' }], { name: '' })
+ * @example validate([{ key: 'name', msg: '姓名最多不能超过十个字', type: 'maxLength', len: 10 }], { name: '12345678901234567890' })
+ */
+export declare function validate<T extends Record<any, any>>(rules: TRules<T>[], data: T): Promise<{
+    valid: boolean;
+    key?: any;
+    msg?: string;
+    len?: number;
+    type?: string;
+}>;
+/**
+ * 校验规则 - 必填
+ */
+export type TRulesRequire<T = Record<any, any>> = {
+    key: keyof T;
+    msg: string;
+};
+/**
+ * form 表单校验规则 -> 仅作必填校验
+ * @param rules 规则
+ * @param data 已填写的数据
+ * @returns valid 是否通过校验，msg 错误信息
+ * @example validate([{ key: 'name', msg: '请输入姓名' }], { name: '' })
+ */
+export declare function validateRequire<T extends Record<any, any>>(rules: TRulesRequire<T>[], data: T): {
+    key: any;
+    msg: string;
+    valid: boolean;
+} | {
+    valid: boolean;
+};

package/lib/types/validator/validator.d.ts

@@ -0,0 +1,71 @@
+export declare const regs: {
+    url: string;
+    email: string;
+    mobile: RegExp;
+    tel: string;
+    idCard: RegExp;
+    card: RegExp;
+    passport: RegExp;
+    currency: string;
+    qq: string;
+    number: string;
+    positiveInt: string;
+    zip: string;
+    double: string;
+    english: string;
+    chinese: string;
+    unSafe: string;
+    date: string;
+    name: RegExp;
+};
+/**
+ * 验证
+ * @param reg 正则表达式
+ * @returns (value: unknown) => boolean
+ */
+export declare function validation(reg: keyof typeof regs): (value: unknown) => boolean;
+/** 金额校验 */
+export declare const isCurrency: (value: unknown) => boolean;
+/** URL验证 */
+export declare const isUrl: (value: unknown) => boolean;
+/** 邮箱验证 */
+export declare const isEmail: (value: unknown) => boolean;
+/** 手机号码验证 */
+export declare const isMobile: (value: unknown) => boolean;
+/** 身份证验证 */
+export declare const isIdCard: (value: unknown) => boolean;
+/** 银行卡号验证 */
+export declare const isCard: (value: unknown) => boolean;
+/** 护照验证 */
+export declare const isPassport: (value: unknown) => boolean;
+/** 验证必填（可验证数组） */
+export declare const required: (value: string | any[]) => boolean;
+/** 验证最大长度 */
+export declare const maxLength: (value: string | any[], max: number) => boolean;
+/** 验证最小长度 */
+export declare const minLength: (value: string | any[], min: number) => boolean;
+/** 校验类型 */
+export declare const validateType: {
+    /** 必填 */
+    required: (value: string | any[]) => boolean;
+    /** 最大长度 */
+    maxLength: (value: string | any[], max: number) => boolean;
+    /** 最小长度 */
+    minLength: (value: string | any[], min: number) => boolean;
+    /** 金额校验 */
+    isCurrency: (value: unknown) => boolean;
+    /** URL验证 */
+    isUrl: (value: unknown) => boolean;
+    /** 邮箱验证 */
+    isEmail: (value: unknown) => boolean;
+    /** 手机号码验证 */
+    isMobile: (value: unknown) => boolean;
+    /** 正整数验证 */
+    isNumber: (value: unknown) => boolean;
+    /** 身份证验证 */
+    isIdCard: (value: unknown) => boolean;
+    /** 银行卡号验证 */
+    isCard: (value: unknown) => boolean;
+    /** 护照验证 */
+    isPassport: (value: unknown) => boolean;
+};

package/package.json

@@ -0,0 +1,53 @@
+{
+  "name": "@spacego/turbo-utils",
+  "version": "0.0.1-alpha",
+  "description": "🚀 A universal tool library. It basically covers all the commonly used practical functions. ",
+  "type": "module",
+  "main": "lib/cjs/index.js",
+  "module": "lib/es/index.js",
+  "typings": "lib/types/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./lib/types/index.d.ts",
+      "import": "./lib/es/index.js",
+      "require": "./lib/cjs/index.js"
+    },
+    "./*": {
+      "types": "./lib/types/*.d.ts",
+      "import": "./lib/es/*.js",
+      "require": "./lib/cjs/*.js"
+    }
+  },
+  "files": [
+    "lib"
+  ],
+  "keywords": [
+    "utils",
+    "turbo",
+    "turbo-utils",
+    "common",
+    "tools",
+    "dayjs",
+    "decimal",
+    "is"
+  ],
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/",
+    "access": "public"
+  },
+  "author": "dshuais",
+  "license": "MIT",
+  "devDependencies": {
+    "rollup-plugin-clear": "^2.0.7",
+    "typescript": "^5.8.3",
+    "vite": "^6.3.3",
+    "vite-plugin-dts": "^4.5.3"
+  },
+  "dependencies": {
+    "dayjs": "^1.11.13",
+    "decimal.js": "^10.5.0"
+  },
+  "scripts": {
+    "build": "vite build"
+  }
+}