# validate-util

**Repository Path**: micky267/validate-util

## Basic Information

- **Project Name**: validate-util
- **Description**: 校验数据工具类
- **Primary Language**: JavaScript
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-06-21
- **Last Updated**: 2022-09-22

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<!--
 * @Description: 
 * @Version: 1.0
 * @Autor: chenmeiqi
 * @LastEditors: chenmeiqi
 * @Date: 2022-06-16 17:18:54
 * @LastEditTime: 2022-06-30 18:46:37
-->
<h1 align="center">@micky267/data-validate-util</h1>
<div align="center">
一个校验数据的工具包
</div>


## 下载

Browser：

```html
<script src='./node_modules/@micky267/data-validate-util/dist/validate-util.min.js'></script>
```

CDN：

```html
<script src='https://unpkg.com/@micky267/data-validate-util@latest/dist/validate-util.min.js'></script>
```

[Node.js](http://nodejs.org)：

```bash
npm install @micky267/data-validate-util -save
```

```javascript
const validateUtil = require('@micky267/data-validate-util');
```

ES module：

```javascript
import validateUtil from "@micky267/data-validate-util";
```

## 例子

```javascript
import validateUtil from "@micky267/data-validate-util";
const check = validateUtil.isUsefulValue(0) // true
const check = validateUtil.isDateFormat('2022-02-22 18:00:00','Y-M-D h:m:s') // true
const check = validateUtil.isDateFormat('2022/02/22 18:00:00','Y-M-D h:m:s') // false

```

## 方法

| 方法名 | 描述  |
| ------------- | ------------------------------ |
|  isUsefulValue(value) |   是否不为null,"",false,undefined,NaN  
|  isNumber(value) |  数值类型
|  numMaxPrecision(value, maxPrecision) |  一个数值类型最多可以保留多少位小数  
|  isIdCard(value) |  身份证
|  isEmail(value) |  邮箱
|  isMobilePhone(value) |  手机号码
|  isTelephone(value) |  固定电话号码
|  isMobileOrTelephone(value) |  固定电话或者手机号码
|  isUrl(value) |  url
|  isDateFormat(value) |  日期格式校验。规定的格式 Y-年  M-月 D-天 h-时 m-分 s-秒 （必须按YMDhms顺序定义规范，可从后往前逐渐减少，比如 Y-M-D h:m）

<br/>

```typescript
    /**
     * @description: 是否不为null,"",false,undefined,NaN
     * @param {any} value
     * @return {boolean}
     */
    isUsefulValue: (value: any) => boolean;
    /**
     * @description: 数值类型校验
     * @param value 校验的数据
     * ``` js
     * isNumber(123)   // true
     * isNumber('123') // true
     * isNumber('123.12') // true
     * isNumber('aa') // false
     *
     * ```
     */
    isNumber: (value: number | string) => boolean;
    /**
     * @description: 一个数值类型最多可以保留多少位小数.
     * @param value 校验的值
     * @param maxPrecision 保留多少位小数
     *
     *  ``` js
     * isNumber('123', 1) // true
     * isNumber('123.21', 1)   // false
     * isNumber('123.21', 2)   // true
     * isNumber('123.21', 3)   // true
     * isNumber('aa') // false
     *
     * ```
     */
    numMaxPrecision: (value: number | string, maxPrecision: number) => boolean;
    /**
     * @description: 身份证校验
     * @param  value 校验的值
     */
    isIdCard: (value: string) => boolean;
    /**
     * @description: 邮箱校验
     * @param {string} value
     */
    isEmail: (value: string) => boolean;
    /**
     * @description: 手机号码校验
     * @param {string} value
     */
    isMobilePhone: (value: string) => boolean;
    /**
     * @description: 固定电话号码校验
     * @param {string} value
     */
    isTelephone: (value: string) => boolean;
    /**
     * @description: 固定电话或者手机号码校验
     * @param {string} value
     */
    isMobileOrTelephone: (value: string) => boolean;
    /**
   * @description: 固定电话或者手机号码校验
   * @param {string} value
   */
    isUrl: (value: string) => boolean;
    /**
     *
     * @description: 日期格式校验
     * @param value
     * @param format 规定的格式 Y-年  M-月 D-天 h-时 m-分 s-秒 （必须按YMDhms顺序定义规范，可从后往前逐渐减少，比如 Y-M-D h）
     * ```js
     * isDateFormat('1997/2/23 14:00', 'Y/M/D h:m') // true
     * isDateFormat('1997-2-23 14:00', 'Y/M/D h:m') // false
     * isDateFormat('1997年02月23日 14:00:00', 'Y年M月D日 h:m:s') // true
     * isDateFormat('1997年02月', 'Y年M月D日 h:m:s') // false
     * isDateFormat('1997', 'Y') // true
     *
     * ```
     */
    isDateFormat: (value: string, format?: string) => boolean;
```