npm 包 certiorem 使用教程

简介

Certiorem 是一个帮助前端开发者进行数据验证的工具库，支持多种数据类型的验证，并且提供了多个常用验证规则的实现。本文将详细介绍 Certiorem 的使用方法和示例。

安装

可以使用 npm 来安装 Certiorem：

npm install certiorem

使用

在 Node.js 环境或支持 ES6 模块语法的浏览器环境中，可以直接使用 import 导入 Certiorem：

import Certiorem from 'certiorem';

也可以使用 CommonJS 的 require 导入：

const Certiorem = require('certiorem');

API

Certiorem 提供了一系列验证规则的实现，可以通过以下 API 进行使用。

exists(value: any) => boolean

判断一个值是否存在，可以判断 undefined、null、空字符串等。

Certiorem.exists(''); // false
Certiorem.exists(null); // false
Certiorem.exists(undefined); // false
Certiorem.exists(0); // true
Certiorem.exists(false); // true

isString(value: any) => boolean

判断一个值是否为字符串类型，并且非空。

Certiorem.isString('hello'); // true
Certiorem.isString(''); // false

isObject(value: any) => boolean

判断一个值是否为对象类型。

Certiorem.isObject({ key: 'value' }); // true
Certiorem.isObject(null); // false
Certiorem.isObject(42); // false

isNumber(value: any) => boolean

判断一个值是否为数值类型，可以判断整数、浮点数等。

Certiorem.isNumber(0); // true
Certiorem.isNumber(3.14); // true
Certiorem.isNumber('hello'); // false
Certiorem.isNumber({ key: 'value' }); // false

isBoolean(value: any) => boolean

判断一个值是否为布尔类型。

Certiorem.isBoolean(true); // true
Certiorem.isBoolean(false); // true

isArray(value: any) => boolean

判断一个值是否为数组类型。

Certiorem.isArray([1, 2, 3]); // true
Certiorem.isArray('hello'); // false

isEmail(value: string) => boolean

判断一个字符串是否为有效的电子邮件地址。

Certiorem.isEmail('foo@example.com'); // true
Certiorem.isEmail('bar@192.168.1.1'); // false

isPassword(value: string) => boolean

判断一个字符串是否为有效的密码格式。要求密码长度在 8 到 20 个字符之间，必须同时包含大写字母、小写字母、数字和特殊字符。

Certiorem.isPassword('123456789aA!@#$%^&*()_+'); // true
Certiorem.isPassword('password'); // false

isPhone(value: string) => boolean

判断一个字符串是否为有效的电话号码格式。要求必须以数字开头，支持括号包括的区号，支持“-”分隔区号和电话号码。

Certiorem.isPhone('13012345678'); // true
Certiorem.isPhone('(010)12345678'); // true
Certiorem.isPhone('020-12345678'); // true

isUrl(value: string) => boolean

判断一个字符串是否为有效的 URL 地址格式。要求必须包含协议部分，支持 http、https、ftp 等协议。

Certiorem.isUrl('http://example.com/path/to/file'); // true
Certiorem.isUrl('ftp://example.com/path/to/file'); // true
Certiorem.isUrl('example.com/path/to/file'); // false

isIdCard(value: string) => boolean

判断一个字符串是否为有效的身份证号格式。要求必须符合中国公民身份证号格式的规范。

Certiorem.isIdCard('110101200001016999'); // true
Certiorem.isIdCard('11010120000101699X'); // true
Certiorem.isIdCard('110101200001016997'); // false

isChinese(value: string) => boolean

判断一个字符串是否为纯中文字符串。

Certiorem.isChinese('你好世界'); // true
Certiorem.isChinese('hello'); // false

moreThan(length: number) => (value: string)

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60055f1681e8991b448dcabb