{"_id":"@4a/sms","_rev":"2-c3a7ec88bc4a65ecc48ebd59c488b9e2","name":"@4a/sms","dist-tags":{"latest":"0.2.1"},"versions":{"0.2.0":{"name":"@4a/sms","version":"0.2.0","description":"telephone code, 短信验证码","main":"dist/index.js","scripts":{"dev":"tsc --watch","build":"tsc","prepublish":"npm run build","test":"mocha test/sms.spec.js"},"repository":{"type":"git","url":"git+https://github.com/gavinning/sms.git"},"keywords":["sms","aliyun","aliyun-sms","alisms","qcloud","qcloud-sms"],"author":{"name":"gavinning"},"license":"MIT","bugs":{"url":"https://github.com/gavinning/sms/issues"},"homepage":"https://github.com/gavinning/sms#readme","devDependencies":{"@types/ioredis":"^4.27.1","@types/node":"^16.3.2","ioredis":"^4.16.3","mocha":"^7.1.1","typescript":"^4.3.5"},"dependencies":{"@4a/asp":"^1.0.1","@alicloud/pop-core":"^1.7.9","tencentcloud-sdk-nodejs":"^4.0.194"},"gitHead":"eec11aa2be7f655a2c886afe96bbca05ae634861","_id":"@4a/sms@0.2.0","_nodeVersion":"14.17.3","_npmVersion":"6.14.13","dist":{"integrity":"sha512-TsY+zWW+eqdfzpfnuJSrRNPsBMdWAY/kzZIjk1m0qddpfknp7IlATqMQwJgH9D7CzjPNbvJNm91ojO7mH5w26A==","shasum":"191745dd480d2b09b47bf9fe0428c43b83101814","tarball":"https://registry.npmjs.org/@4a/sms/-/sms-0.2.0.tgz","fileCount":18,"unpackedSize":18483,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhM0W/CRA9TVsSAnZWagAAhS0P+weh/OKUhdrDZsyiKoyo\nZH2kUejHxu3lZtDvO7BbWGVcAXUIeSgXynVBIjsYHT4EGMpqWVjqv2rEoYZJ\noc4d5Y7ANQjrZB2WSpDrgncrY/IkfypFOD60GoDX93D5a+4HidLOSIwN7sUe\nbXvf4LS8NNSDz9lAa3FOJT0QmHw6G7ov0G7cN+GNKYDtUuZEWnJp3qai4IuG\nDNeJRBd7U35bxNLzjzK4FJne8UmbtHLsi3Bpv3ZXBchluO+9Z1PtsVgVPm7x\n5PX7tNyFxuJdLebUaGNXAOXGkcnoSZkJX63hKrLnZFeKWk8x+NUB2KbxJ8zV\n6TLtk6mFMpJ5vVhKvirPOCBGys9WPf2Hu8QVpwKSN3WSXnz3R1qTCXPFFg89\nQ9+A+j4+0MMER0cgOlbbdery1JtphQQ1DWgUvXVm9EGI7UKEY+FYgk726+Fn\nKCaBi1iFdjNZRsrrQqxX48TpZja8nsEod+xRkjlIEqPgYqjaa/bsI04Dabt3\nenTTurI8s6uUHjq7Zhu+sBVx1+qg4ur8tSTPx70/lCqvLXTPRCe5ZtPfCdxd\nLiPRQAKg3lmZ5eiVlTv361eAkCPjwlNXKZ5I5ttdkarHZwDu4Rfam3t/+WUx\nY8mWzdmPjer8Y+w1QClUbx3IlMw1v7ruzqhCqEg6d6aLWd07Lplz7gsbi38F\nkKsO\r\n=GfDV\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIEy6IJkGRJ1uTIHWznUesnEc0VrdLKkhpzcpC3VlTekwAiBYBcWFGE4+uGGwkne4B+HXC6ykior3THsVST3gswaE0A=="}]},"_npmUser":{"name":"gavinning","email":"gavinning@qq.com"},"directories":{},"maintainers":[{"name":"gavinning","email":"gavinning@qq.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/sms_0.2.0_1630750143319_0.75249076678983"},"_hasShrinkwrap":false},"0.2.1":{"name":"@4a/sms","version":"0.2.1","description":"telephone code, 短信验证码","main":"dist/index.js","scripts":{"dev":"tsc --watch","build":"tsc","prepublish":"npm run build","test":"mocha test/sms.spec.js"},"repository":{"type":"git","url":"git+https://github.com/gavinning/sms.git"},"keywords":["sms","aliyun","aliyun-sms","alisms","qcloud","qcloud-sms"],"author":{"name":"gavinning"},"license":"MIT","bugs":{"url":"https://github.com/gavinning/sms/issues"},"homepage":"https://github.com/gavinning/sms#readme","devDependencies":{"@types/ioredis":"^4.27.1","@types/node":"^16.3.2","ioredis":"^4.16.3","mocha":"^7.1.1","typescript":"^4.3.5"},"dependencies":{"@4a/asp":"^1.0.1","@alicloud/pop-core":"^1.7.9","tencentcloud-sdk-nodejs":"^4.0.194"},"gitHead":"a2a30289b804df288877d7d4e1bb287f2187dd37","_id":"@4a/sms@0.2.1","_nodeVersion":"14.17.3","_npmVersion":"6.14.13","dist":{"integrity":"sha512-L0xtiT9gi8KT2d+UMSeTx4ZCfD0LH89e+xB44A1FcqwXGcpec91XWh7TcVtgh+gy+mgVJAffzD/B7FHHOscWUA==","shasum":"0b4fb8c0697ba4fb831a04f6a40ef3856ffd4f3c","tarball":"https://registry.npmjs.org/@4a/sms/-/sms-0.2.1.tgz","fileCount":18,"unpackedSize":18755,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhOIMRCRA9TVsSAnZWagAAYJMP+waUp2D6hxYDpef0opQf\nAdM5qO6T6wddNp1wjTU6fWPZ33BAILvT0ra+5kN9euTKTfYAub8Dy/LvcIUu\niBnKe/JpPYa5htFky0T+UL39s9iy96FtReo7GLYfQdrpB8Zk0GfJ6Z/o+j9H\nBBCyOSoPmPnj4q/jMwsagvHdbjfvXIPNGHuosQJFlmOwfkDM2d+tTwVNlf/o\nDsNJS+RfPXnNirviZu5OytATWhXoTh8whVjx/lVhd/3TO48GLE/GzixVQn79\nm3fwjgZpjONcykHh0EhyrkC0Zudk8G6dpeNe2gOJ6QBoZb82uuhCxPpCXncp\nJ0iJQWkA29fw5O944zCyIPi+BCUxDIwPAQv93novhM490LE+z8+Ec+WdTjdX\nL9X7Cnfb9WHZYJ880JoTLi+gR0+emvVLKfggZfOpP2ANkJQ7/oxww8/uAXaT\nd7HcVeWOFa+xWlxZ5mWj034GPwN1hlDK/N8KiFt17sIoDD+1uRaP2pQjf0Dw\nrgJNeymVdvB+ubv2WX27IfktTPY7v315jd1nlT0jqXiqttSfJqU7u0l/KG3z\nWQyKStv6mZH45T7b+NX1sVEA4hFHA5RbGpgKM6ytaAhMvoHI+CV7kV2NvhG0\nbXmwNIObyyyvFu7U3mfeSPS9gxnElqEsG3LWmFDgE673b5aA/h8+ZaEmeQGj\nEDi9\r\n=AdSC\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDn9pyys+wI4r6vg8vYXAuNjpg9HfBLo4uO8vysqfmMnQIgDPoubT3jcRFIglFgOALCVY749UbRmpkiLcoMpGyPbZ4="}]},"_npmUser":{"name":"gavinning","email":"gavinning@qq.com"},"directories":{},"maintainers":[{"name":"gavinning","email":"gavinning@qq.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/sms_0.2.1_1631093520956_0.7647451556124194"},"_hasShrinkwrap":false}},"time":{"created":"2021-09-04T10:09:03.260Z","0.2.0":"2021-09-04T10:09:03.435Z","modified":"2022-04-04T10:46:02.530Z","0.2.1":"2021-09-08T09:32:01.088Z"},"maintainers":[{"name":"gavinning","email":"gavinning@qq.com"}],"description":"telephone code, 短信验证码","homepage":"https://github.com/gavinning/sms#readme","keywords":["sms","aliyun","aliyun-sms","alisms","qcloud","qcloud-sms"],"repository":{"type":"git","url":"git+https://github.com/gavinning/sms.git"},"author":{"name":"gavinning"},"bugs":{"url":"https://github.com/gavinning/sms/issues"},"license":"MIT","readme":"SMS短信验证码\n---\n* 阿里云短信验证码发送和验证\n* 腾讯云短信验证码发送和验证\n\n### Install\n```sh\nnpm i @4a/sms\n# or\nyarn add @4a/sms\n```\n\n### Options\n```ts\ninterface Options {\n    mode: Mode\n    redis: Redis // ioredis\n    debug?: boolean\n    qqconfig?: QcloudConfig\n    aliconfig?: AliyunConfig\n}\n\nenum Mode {\n    aliyun = 'aliyun',\n    qcloud = 'qcloud',\n}\n\ninterface QcloudConfig {\n    AppId: string\n    accessKeyId: string\n    accessKeySecret: string\n    SignName: string\n    TemplateId: string\n    RegionId?: string // default = ap-guangzhou\n}\n\ninterface AliyunConfig {\n    accessKeyId: string\n    accessKeySecret: string\n    SignName: string\n    TemplateId: string\n    RegionId?: string // default = cn-hangzhou\n}\n\n```\n\n### Usage\n短信验证码会被存储在redis中\n* 默认有效期：6分钟\n* 默认存储Key：``app:sms:passcode:${tel}``\n```ts\nimport SMS from '@4a/sms'\n```\n```js\nconst { SMS } = require('@4a/sms')\nconst { aliyunConfig, qcloudConfig } = require('./config')\nconst Redis = require('ioredis')\nconst redis = new Redis()\n\nconst client = new SMS({\n    mode: 'aliyun',\n    redis,\n    debug: true,\n    qqconfig: qcloudConfig,\n    aliconfig: aliyunConfig,\n})\n\n// 创建一个短信验证码\n// 模拟发送，可在测试环境使用该api\nclient.create(tel)\n\n// 创建一个短信验证码\n// 真实发送，生产环境使用该api\nclient.send(tel)\n\n\n// 验证短信验证码是否合法\nclient.verify(tel, code)\n```\n","readmeFilename":"readme.md"}