npm 包 typcheckjs 使用教程-JavaScript中文网-JavaScript教程资源分享门户

介绍

typcheckjs 是一个用于 JavaScript 值和数据类型校验的 npm 包，提供了丰富的校验规则和语法，支持链式调用和自定义校验规则，使开发人员能够更轻松地进行输入数据校验，从而提高代码的稳定性和可维护性。

安装

typcheckjs 可以通过 npm 下载，并在项目中引入：

npm install typcheckjs --save

import TypeCheck from 'typcheckjs';

基本使用

typcheckjs 支持链式调用，输入待校验的值，然后通过规则进行校验，最后返回一个布尔值表示校验结果。

简单数据类型

isString：验证字符串类型；
isNumber：验证数字类型；
isBoolean：验证布尔类型；
isFunction：验证函数类型；
isArray：验证数组类型；
isObject：验证对象类型。

const name = 'Peter';
const age = 18;

TypeCheck(name).isString(); // true
TypeCheck(age).isString(); // false

TypeCheck(age).isNumber(); // true
TypeCheck(name).isNumber(); // false

const isMale = true;
TypeCheck(isMale).isBoolean(); // true

const sayHello = function() {
  console.log('Hello, World!');
};
TypeCheck(sayHello).isFunction(); // true

const array = [1, 2, 3];
const obj = {
  name: 'Peter',
  age: 18
};

TypeCheck(array).isArray(); // true
TypeCheck(obj).isObject(); // true

字符串类型

isEmail：验证邮箱格式；
isURL：验证 URL 格式；
isIP：验证 IP 地址格式；
isPhone：验证手机号码格式；
isMobile：验证电话号码格式。

const email = 'peter@example.com';
const url = 'https://www.example.com';
const ip = '127.0.0.1';
const phone = '010-8888888';
const mobile = '13888888888';

TypeCheck(email).isEmail(); // true
TypeCheck(url).isURL(); // true
TypeCheck(ip).isIP(); // true
TypeCheck(phone).isPhone(); // true
TypeCheck(mobile).isMobile(); // true

数字类型

isPositive：验证正数；
isNegative：验证负数；
isInteger：验证整数；
isDecimal：验证小数。

const positiveNumber = 5;
const negativeNumber = -5;
const integerNumber = 5.0;
const decimalNumber = 5.5;

TypeCheck(positiveNumber).isPositive(); // true
TypeCheck(negativeNumber).isNegative(); // true
TypeCheck(integerNumber).isInteger(); // true
TypeCheck(decimalNumber).isDecimal(); // true

字符串和数组类型

isLength：验证字符串长度，包括中文字符；
isNotEmpty：验证字符串或数组是否为空；
isIn：验证字符串是否在指定范围内。

const username = 'Peter';
const tasks = ['task1', 'task2', 'task3'];

TypeCheck(username).isLength(4, 8); // true
TypeCheck(tasks).isNotEmpty(); // true
TypeCheck('task4').isIn(['task1', 'task2', 'task3']); // false

自定义校验规则

typcheckjs 支持自定义校验规则，只需要传入一个回调函数，然后在函数中编写校验逻辑即可。

TypeCheck.addRule('isAdult', value => {
  return TypeCheck(value).isNumber() && value >= 18;
});

const age = 18;

TypeCheck(age).isAdult(); // true

结论

typcheckjs 提供了丰富的数据类型校验规则和语法，可以有效地帮助开发人员进行输入数据校验。在实际项目中，我们可以根据具体情况选择合适的校验规则和自定义规则，以提高代码的稳定性和可维护性。

来源：JavaScript中文网，转载请注明来源本文地址：https://www.javascriptcn.com/post/600673defb81d47349e53bb5

npm 包 typcheckjs 使用教程

介绍

安装