https://github.com/liyipeng3/sms-code
用于生成短信随机验证码以及验证验证码的npm库
https://github.com/liyipeng3/sms-code
nodejs npmjs sms-code
Last synced: 6 months ago
JSON representation
用于生成短信随机验证码以及验证验证码的npm库
- Host: GitHub
- URL: https://github.com/liyipeng3/sms-code
- Owner: liyipeng3
- License: mit
- Created: 2020-08-28T18:11:27.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2020-11-06T13:20:16.000Z (over 4 years ago)
- Last Synced: 2024-11-10T11:51:59.082Z (7 months ago)
- Topics: nodejs, npmjs, sms-code
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/sms-code
- Size: 54.7 KB
- Stars: 3
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# sms-code
[](https://nodei.co/npm/sms-code/)
## Installation
Using npm:
```shell
$ npm i sms-code
```
Note: add `--save` if you are using npm < 5.0.0
## Usage
0.快速开始
```javascript
// nodejs 运行环境
const smsCode = require('sms-code')
// es6
import smsCode from 'sms-code'
const code = smsCode.getCode('188888888888') // 随机数 如：3333
smsCode.verifyCode('18888888888', code) // 验证结果 true/false
```
1.用于生成随机验证码以及验证验证码
```javascript
smsCode.getCode('188888888888') // 随机数 如：3333
smsCode.verifyCode('18888888888', '3333') // 验证结果 true/false
```
2.每个手机号对应的验证码只能被验证一次且可自定义有效期
3.可以设置验证码过期时间以及验证码长度
```javascript
smsCode.setOptions({
age: 5, // 默认有效时间为五分钟
length: 4 // 默认长度为四位
})
```