@uni/scan

scan

调用扫一扫功能的 API。

支持

安装

$ npm install @uni/scan --save

or

$ npm install @uni/apis --save

示例

import scan from '@uni/scan';

scan({
  scanType: ['qrCode','barCode'],
  success (res) {
    console.log(res.result)
  },
  fail (res) {
    console.log(res)
  }
});

// promise
scan({
  scanType: ['qrCode','barCode'],
}).then(res => {
  console.log(res.result)
});

你也可以从大包引入：

import { scan } from '@uni/apis';

方法

scan(options)

参数

成员	类型	描述	必选	默认值
options	object		✘	-
options.success	Function	成功的回调	✘	-
options.fail	Function	失败的回调	✘	-
options.complete	Function	结束的回调 （调用成功、失败都会执行）	✘	-

object.scanType 的合法值

值	说明	支持
barCode	一维码
qrCode	二维码
dmCode	Data Matrix 码
pdf417Code	PDF417 条码
narrowCode	窄条二维码
hmCode	异构码

不通用参数（由于破坏了一码多端的能力，请谨慎使用）

成员	类型	描述	必选	默认值	支持度
options.hideAlbum	Boolean	是否隐藏相册（不允许从相册选择图片），只能从相机扫码	✘	false
options.scanType	Array<string>	所扫码的类型	✘	['barCode', 'qrCode']

返回

成员	类型	描述
result	string	所扫码的内容

不通用返回（由于破坏了一码多端的能力，请谨慎使用）

成员	类型	描述	支持度
charSet	string	所扫码的字符集
path	string	当所扫的码为当前小程序二维码时，会返回此字段，内容为二维码携带的 path
scanType	string	所扫码的类型
rawData	string	原始数据，base64编码
imageChannel	string	来源
code	string	扫码所得数据
qrCode	string	扫描二维码时返回二维码数据
barCode	string	扫描条形码时返回条形码数据

微信小程序