diff --git a/README.md b/README.md index 83914a6..ef04032 100644 --- a/README.md +++ b/README.md @@ -10,11 +10,35 @@ ``` const captcha = require('@itriton/captcha') +// 默认 captcha.create().then(res=>{ console.log(res) }) + +// 自定义参数 +captcha.create(options).then(res=>{ + console.log(res) +}) ``` + +#### 参数 + +| 属性名 | 类型 | 默认值 | 说明 | +| --------- | ------- | ---------- | ----------------- | +| size | Number | 30 | 默认拼图大小 | +| width | Number | 270 | 图片宽度(px) | +| height | Number | 144 | 图片高度(px) | +| url | String | - | 图片路径 | + +#### 返回值 + +| 属性名 | 类型 | 说明 | +| --------- | ------- | ---------- | +| backgroundImage | Base64 | 背景图片 | +| jigsawImage | Base64 | 拼图图片 | +| x | Number | x轴距离| + ### 安装sharp失败的解决方案 切换成淘宝镜像再执行`npm install sharp`命令 diff --git a/index.js b/index.js index e77eb24..6a32aae 100644 --- a/index.js +++ b/index.js @@ -66,7 +66,7 @@ const create = async function (options) { "base64" )}`, jigsawImage: `data:image/jpg;base64,${jigsawImage.toString("base64")}`, - left, + x: left, }; };