id-scanner-lib
Version:
Browser-based ID card, QR code, and face recognition scanner with liveness detection
52 lines (51 loc) • 1.39 kB
TypeScript
/**
* @file 二维码模块入口
* @description 提供二维码识别和解析功能的模块入口
* @module modules/qrcode
*/
import { BaseModule } from '../../core/base-module';
import { QRCodeResult, QRCodeModuleOptions } from './types';
/**
* 二维码模块
* 提供二维码检测和解析功能
*/
export declare class QRCodeModule extends BaseModule {
/** 模块名称 */
readonly name: string;
/** 模块配置 */
private options;
/** 二维码扫描器 */
private scanner;
/** 最后一次扫描结果 */
private lastScanResult?;
/**
* 构造函数
* @param options 模块配置选项
*/
constructor(options?: QRCodeModuleOptions);
/**
* 初始化模块
*/
initialize(): Promise<void>;
/**
* 扫描图像中的二维码
* @param image 图像源
* @returns 二维码扫描结果
*/
scan(image: ImageData | HTMLImageElement | HTMLCanvasElement): Promise<QRCodeResult | undefined>;
/**
* 获取最后一次扫描结果
*/
getLastScanResult(): QRCodeResult | undefined;
/**
* 解析二维码数据
* @param data 二维码数据
* @returns 解析后的数据对象
*/
parseQRCodeData(data: string): Record<string, any> | string;
/**
* 释放模块资源
*/
dispose(): Promise<void>;
}
export * from './types';