Skip to content

Commit

Permalink
更新测试脚本,API 描述问题
Browse files Browse the repository at this point in the history
  • Loading branch information
huntshark committed Jul 16, 2018
1 parent 7c1313f commit 710964d
Show file tree
Hide file tree
Showing 120 changed files with 1,684 additions and 379 deletions.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,13 @@
validator
===========================

[![Build Status](https://travis-ci.org/sTdobTs/validator.svg?branch=master)](https://travis-ci.org/sTdobTs/validator)
[![NPM version](http://img.shields.io/npm/v/jxm-validator.svg)](https://npmjs.org/package/jxm-validator)
[![Build Status](https://travis-ci.org/sTdobTs/validator.svg?branch=master)](https://travis-ci.org/sTdobTs/validator)
[![Coverage Status](https://coveralls.io/repos/github/sTdobTs/validator/badge.svg?branch=master)](https://coveralls.io/github/sTdobTs/validator?branch=master)
[![Downloads](http://img.shields.io/npm/dm/jxm-validator.svg)](https://npmjs.org/package/jxm-validator)
[![License](https://img.shields.io/npm/l/jxm-validator.svg?maxAge=2592000)](https://github.com/sTdobTs/validator/blob/master/LICENSE)

> [中文](https://github.com/sTdobTs/validator/blob/master/README.zh-CN.md) | [English](https://github.com/sTdobTs/validator)
This is a modern JavaScript verification toolkit library, running on Node.js and in the modern browser, provide feature-rich verification function, making verification simple and fun.

Expand Down Expand Up @@ -44,15 +47,15 @@ In Node.js:

## Documentation

API Docs, please see [here](https://github.com/sTdobTs/validator/blob/master/docs/en-US/APIs.md).
API Docs, please open [here](https://github.com/sTdobTs/validator/blob/master/docs/en-US/APIs.md).

## Community

If you have any question, please open an issue [here](https://github.com/sTdobTs/validator/issues).

## Changelog

If you search all changes, please open [here](https://github.com/sTdobTs/validator/wiki/Changelog)
If you see all changes, please open [here](https://github.com/sTdobTs/validator/wiki/Changelog)

## License

Expand Down
11 changes: 7 additions & 4 deletions README.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,13 @@
validator
===========================

[![Build Status](https://travis-ci.org/sTdobTs/validator.svg?branch=master)](https://travis-ci.org/sTdobTs/validator)
[![NPM version](http://img.shields.io/npm/v/jxm-validator.svg)](https://npmjs.org/package/jxm-validator)
[![Build Status](https://travis-ci.org/sTdobTs/validator.svg?branch=master)](https://travis-ci.org/sTdobTs/validator)
[![Coverage Status](https://coveralls.io/repos/github/sTdobTs/validator/badge.svg?branch=master)](https://coveralls.io/github/sTdobTs/validator?branch=master)
[![Downloads](http://img.shields.io/npm/dm/jxm-validator.svg)](https://npmjs.org/package/jxm-validator)
[![License](https://img.shields.io/npm/l/jxm-validator.svg?maxAge=2592000)](https://github.com/sTdobTs/validator/blob/master/LICENSE)

> [中文](https://github.com/sTdobTs/validator/blob/master/README.zh-CN.md) | [English](https://github.com/sTdobTs/validator)
基于 ECMAScript5.1 实现的验证工具包,提供了丰富的校验和工具方法,在 Node.js 和现代浏览器中可以使用。

Expand All @@ -28,15 +31,15 @@ validator
在 Node.js 中使用:

```javascript
// reference
// 引用
const jxmValidator = require('jxm-validator');

// Check negative number
// 检验 负数
jxmValidator.isNegativeNumber(-2); // => true
jxmValidator.isNegativeNumber(-2.3); // => true
jxmValidator.isNegativeNumber(2.3); // => false

// Check postive integer
// 校验 正整数
jxmValidator.isPositiveInteger(2); // => true
jxmValidator.isPositiveInteger(2.3); // => false
jxmValidator.isPositiveInteger(-2); // => false
Expand Down
3 changes: 2 additions & 1 deletion docs/en-US/APIs.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,10 @@
API 文档
===========================

假设,您已经阅读,并且已经知道如何使用,可以直接跳过该步骤。如果还没有看过的同学,请看这里,引入`jxm-validator`
假设,您已经阅读,并且知道如何使用,可以直接跳过该步骤。若是还没有看过的同学,请看这里:

```javascript
// 引入 `jxm-validator`
const jxmValidator = require('jxm-validator');

jxmValidator.isNull(null);
Expand Down
2 changes: 1 addition & 1 deletion docs/en-US/APIs/isArray.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@

#### 说明:

仅当参数 val 为 `array` 时,返回 `true`, 否则返回 `false`
当参数 val 为 `array` 时,返回 `true`, 否则返回 `false`

#### 示例:

Expand Down
2 changes: 1 addition & 1 deletion docs/en-US/APIs/isBoolean.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@

#### 说明:

仅当参数 val 为 `boolean` 时,返回 `true`, 否则返回 `false`
当参数 val 为 `boolean` 时,返回 `true`, 否则返回 `false`

#### 示例:

Expand Down
1 change: 1 addition & 0 deletions docs/en-US/APIs/isEmail.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,5 @@ jxmValidator.isEmail('575099329@qq'); // => false
jxmValidator.isEmail('dotx575099329@gmail.com'); // => true
jxmValidator.isEmail('dotx575099329@163.com'); // => true
jxmValidator.isEmail('dotx575099329@qingniu.co'); // => true
jxmValidator.isEmail(333); // => false
```
12 changes: 11 additions & 1 deletion docs/en-US/APIs/isEmptyString.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,9 @@

#### 说明:

该接口存在两种模式, 即严格模式、非严格模式,默认采用严格模式
该接口存在两种模式, 即严格模式、非严格模式

默认采用 `严格模式`

若参数 `val` 不是 string, 则直接返回 false
若参数 `val` 是 string 并且为空(''), 则返回 true, 否则返回 false
Expand All @@ -32,11 +34,19 @@
#### 示例:

```javascript
jxmValidator.isEmptyString(3); // => false
jxmValidator.isEmptyString('3'); // => false

jxmValidator.isEmptyString(0); // => false

jxmValidator.isEmptyString(''); // => true
jxmValidator.isEmptyString('', {isStrict: false})); // => true

jxmValidator.isEmptyString(' '); // => true
jxmValidator.isEmptyString(' ', {isStrict: false}); // => false

jxmValidator.isEmptyString(null); // => false
jxmValidator.isEmptyString(undefined); // => false

jxmValidator.isEmptyString(NaN); // => false
```
2 changes: 1 addition & 1 deletion docs/en-US/APIs/isFunction.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@

#### 说明:

仅当参数 val 为 `function` 时,返回 `true`, 否则返回 `false`
当参数 val 为 `function` 时,返回 `true`, 否则返回 `false`

#### 示例:

Expand Down
2 changes: 1 addition & 1 deletion docs/en-US/APIs/isInfinity.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@

#### 说明:

仅当参数 val 为 `Infinity` 或 `-Infinity` 时,返回 `true`, 否则返回 `false`
当且仅当参数 val 为 `Infinity` 或 `-Infinity` 时,返回 `true`, 否则返回 `false`

#### 示例:

Expand Down
38 changes: 29 additions & 9 deletions docs/en-US/APIs/isInteger.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,16 @@

#### 说明:

该接口存在两种模式, 即严格模式、非严格模式; 默认采用`非严格模式`
该接口存在两种模式, 即严格模式、非严格模式;

默认采用 `非严格模式`

若参数 `val` 为 number 类型, 并且是整数 则返回 true, 否则返回 false
若参数 `val` 为 string 类型, 并且通过验证为整数字符串, 则返回 true, 否则返回 false
若参数 `val` 不属于以上两种类型, 则直接返回 false

若参数 `val` 的值为空字符串(''、' '), 则直接返回 false

若是参数 `options` 指定了严格模式, 即 options.isStrict = true, 则对于 string 类型直接返回 false

e.g.
Expand All @@ -34,19 +38,35 @@
```javascript
jxmValidator.isInteger(3); // => true
jxmValidator.isInteger('3'); // => true
jxmValidator.isInteger(3.3); // => false
jxmValidator.isInteger('3.3'); // => false
jxmValidator.isInteger(3, {isStrict: true}); // => true
jxmValidator.isInteger('3', {isStrict: true}); // => false

jxmValidator.isInteger(0); // => true
jxmValidator.isInteger('0'); // => true
jxmValidator.isInteger(0, {isStrict: true}); // => true
jxmValidator.isInteger('0', {isStrict: true}); // => false

jxmValidator.isInteger(-3); // => true
jxmValidator.isInteger('-3'); // => true
jxmValidator.isInteger(-3.3); // => false
jxmValidator.isInteger('-3.3'); // => false
jxmValidator.isInteger(-3, {isStrict: true}); // => true
jxmValidator.isInteger('-3', {isStrict: true}); // => false

jxmValidator.isInteger('3', {isStrict: true}); // => false
jxmValidator.isInteger(3.3); // => false
jxmValidator.isInteger('3.3'); // => false
jxmValidator.isInteger(3.3, {isStrict: true}); // => false
jxmValidator.isInteger('3.3', {isStrict: true}); // => false
jxmValidator.isInteger('-3', {isStrict: true}); // => false

jxmValidator.isInteger(-3.3); // => false
jxmValidator.isInteger('-3.3'); // => false
jxmValidator.isInteger(-3.3, {isStrict: true}); // => false
jxmValidator.isInteger('-3.3', {isStrict: true}); // => false

jxmValidator.isInteger(0); // => true
jxmValidator.isInteger('0'); // => true
jxmValidator.isInteger(''); // => false
jxmValidator.isInteger(' '); // => false
jxmValidator.isInteger(null); // => false
jxmValidator.isInteger(undefined); // => false

jxmValidator.isInteger(NaN); // => false
jxmValidator.isInteger(Number.POSITIVE_INFINITY); // => false
jxmValidator.isInteger(Number.NEGATIVE_INFINITY); // => false
```
1 change: 1 addition & 0 deletions docs/en-US/APIs/isJSON.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@

```javascript
jxmValidator.isJSON('{"a": 3}'); // => true
jxmValidator.isJSON('{a: 3}'); // => false
jxmValidator.isJSON('[3, 4]'); // => false
jxmValidator.isJSON('3'); // => false

Expand Down
8 changes: 7 additions & 1 deletion docs/en-US/APIs/isMobile.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@

val,任意类型

locale,可选参数,默认值 'ZHCN'
locale,可选参数,默认值 'zh-CN'

#### 说明:

Expand All @@ -26,8 +26,14 @@
```javascript
jxmValidator.isMobile('18505505933'); // => true
jxmValidator.isMobile('28505505933'); // => false

jxmValidator.isMobile('185055059334'); // => false
jxmValidator.isMobile('1850550593'); // => false

jxmValidator.isMobile('1850550 933'); // => false
jxmValidator.isMobile('1850550-933'); // => false

jxmValidator.isMobile(18505505933); // => false

jxmValidator.isMobile('18505505933', 'en-US'); // => false
```
2 changes: 1 addition & 1 deletion docs/en-US/APIs/isNaN.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@

#### 说明:

仅当参数 val 为 `NaN` 时,返回 `true`, 否则返回 `false`
当且仅当参数 val 为 `NaN` 时,返回 `true`, 否则返回 `false`

#### 示例:

Expand Down
38 changes: 29 additions & 9 deletions docs/en-US/APIs/isNegativeInteger.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,16 @@

#### 说明:

该接口存在两种模式, 即严格模式、非严格模式; 默认采用`非严格模式`
该接口存在两种模式, 即严格模式、非严格模式;

默认采用 `非严格模式`

若参数 `val` 为 number 类型, 并且是负整数 则返回 true, 否则返回 false
若参数 `val` 为 string 类型, 并且通过验证为负整数字符串, 则返回 true, 否则返回 false
若参数 `val` 不属于以上两种类型, 则直接返回 false

若参数 `val` 的值为空字符串(''、' '), 则直接返回 false

若是参数 `options` 指定了严格模式, 即 options.isStrict = true, 则对于 string 类型直接返回 false

e.g.
Expand All @@ -34,19 +38,35 @@
```javascript
jxmValidator.isNegativeInteger(3); // => false
jxmValidator.isNegativeInteger('3'); // => false
jxmValidator.isNegativeInteger(3.3); // => false
jxmValidator.isNegativeInteger('3.3'); // => false
jxmValidator.isNegativeInteger(3, {isStrict: true}); // => false
jxmValidator.isNegativeInteger('3', {isStrict: true}); // => false

jxmValidator.isNegativeInteger(0); // => false
jxmValidator.isNegativeInteger('0'); // => false
jxmValidator.isNegativeInteger(0, {isStrict: true}); // => false
jxmValidator.isNegativeInteger('0', {isStrict: true}); // => false

jxmValidator.isNegativeInteger(-3); // => true
jxmValidator.isNegativeInteger('-3'); // => true
jxmValidator.isNegativeInteger(-3.3); // => false
jxmValidator.isNegativeInteger('-3.3'); // => false
jxmValidator.isNegativeInteger(-3, {isStrict: true}); // => true
jxmValidator.isNegativeInteger('-3', {isStrict: true}); // => false

jxmValidator.isNegativeInteger('3', {isStrict: true}); // => false
jxmValidator.isNegativeInteger(3.3); // => false
jxmValidator.isNegativeInteger('3.3'); // => false
jxmValidator.isNegativeInteger(3.3, {isStrict: true}); // => false
jxmValidator.isNegativeInteger('3.3', {isStrict: true}); // => false
jxmValidator.isNegativeInteger('-3', {isStrict: true}); // => false

jxmValidator.isNegativeInteger(-3.3); // => false
jxmValidator.isNegativeInteger('-3.3'); // => false
jxmValidator.isNegativeInteger(-3.3, {isStrict: true}); // => false
jxmValidator.isNegativeInteger('-3.3', {isStrict: true}); // => false

jxmValidator.isNegativeInteger(0); // => false
jxmValidator.isNegativeInteger('0'); // => false
jxmValidator.isNegativeInteger(''); // => false
jxmValidator.isNegativeInteger(' '); // => false
jxmValidator.isNegativeInteger(null); // => false
jxmValidator.isNegativeInteger(undefined); // => false

jxmValidator.isNegativeInteger(NaN); // => false
jxmValidator.isNegativeInteger(Number.POSITIVE_INFINITY); // => false
jxmValidator.isNegativeInteger(Number.NEGATIVE_INFINITY); // => false
```
20 changes: 19 additions & 1 deletion docs/en-US/APIs/isNegativeNumber.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,16 @@

#### 说明:

该接口存在两种模式, 即严格模式、非严格模式; 默认采用`非严格模式`
该接口存在两种模式, 即严格模式、非严格模式;

默认采用 `非严格模式`

若参数 `val` 为 number 类型, 并且是负数 则返回 true, 否则返回 false
若参数 `val` 为 string 类型, 并且通过验证为负数字符串, 则返回 true, 否则返回 false
若参数 `val` 不属于以上两种类型, 则直接返回 false

若参数 `val` 的值为空字符串(''、' '), 则直接返回 false

若是参数 `options` 指定了严格模式, 即 options.isStrict = true, 则对于 string 类型直接返回 false

e.g.
Expand All @@ -34,11 +38,25 @@
```javascript
jxmValidator.isNegativeNumber(-3); // => true
jxmValidator.isNegativeNumber('-3'); // => true
jxmValidator.isNegativeNumber(-3, {isStrict: true}); // => true
jxmValidator.isNegativeNumber('-3', {isStrict: true}); // => false

jxmValidator.isNegativeNumber(0); // => false
jxmValidator.isNegativeNumber('0'); // => false
jxmValidator.isNegativeNumber(0, {isStrict: true}); // => false
jxmValidator.isNegativeNumber('0', {isStrict: true}); // => false

jxmValidator.isNegativeNumber(3); // => false
jxmValidator.isNegativeNumber('3'); // => false
jxmValidator.isNegativeNumber(3, {isStrict: true}); // => false
jxmValidator.isNegativeNumber('3', {isStrict: true}); // => false

jxmValidator.isNegativeNumber(''); // => false
jxmValidator.isNegativeNumber(' '); // => false
jxmValidator.isNegativeNumber(null); // => false
jxmValidator.isNegativeNumber(undefined); // => false

jxmValidator.isNegativeNumber(NaN); // => false
jxmValidator.isNegativeNumber(Number.POSITIVE_INFINITY); // => false
jxmValidator.isNegativeNumber(Number.NEGATIVE_INFINITY); // => false
```
2 changes: 1 addition & 1 deletion docs/en-US/APIs/isNil.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@

#### 说明:

当参数 val === null 或者 val === undefined 时,返回 `true`, 否则返回 `false`
当且仅当参数 val === null 或者 val === undefined 时,返回 `true`, 否则返回 `false`

#### 示例:

Expand Down
2 changes: 1 addition & 1 deletion docs/en-US/APIs/isNull.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@

#### 说明:

仅当参数 val === null 时,返回 `true`, 否则返回 `false`
当且仅当参数 val === null 时,返回 `true`, 否则返回 `false`

#### 示例:

Expand Down
2 changes: 1 addition & 1 deletion docs/en-US/APIs/isNumber.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@

#### 说明:

仅当参数 val 为 `number` 时,返回 `true`, 否则返回 `false`
当参数 val 为 `number` 时,返回 `true`, 否则返回 `false`

* number 类型还包括: NaN, Infinity, -Infinity

Expand Down
Loading

0 comments on commit 710964d

Please sign in to comment.