@scr2em/capacitor-scanner v6.0.3

Capacitor Scanner

scan codes

Install

npm install capacitor-scanner
npx cap sync

API

• startScanning(...)
• stopScanning()
• openSettings()
• capturePhoto()
• checkPermissions()
• requestPermissions()
• addListener('barcodeScanned', ...)
• removeAllListeners()
• Type Aliases
• Enums

startScanning(...)

startScanning(options?: ScannerOptions | undefined) => Promise<void>

stopScanning()

stopScanning() => Promise<void>

openSettings()

openSettings() => Promise<void>

capturePhoto()

capturePhoto() => Promise<CapturePhotoResult>

Returns: Promise<CapturePhotoResult>

checkPermissions()

checkPermissions() => Promise<PermissionsResult>

Returns: Promise<PermissionsResult>

requestPermissions()

requestPermissions() => Promise<PermissionsResult>

Returns: Promise<PermissionsResult>

addListener('barcodeScanned', ...)

addListener(event: 'barcodeScanned', listenerFunc: (result: BarcodeScannedEvent) => void) => Promise<void>

removeAllListeners()

removeAllListeners() => Promise<void>

Type Aliases

ScannerOptions

{ formats?: BarcodeFormat[]; cameraDirection?: 'BACK' | 'FRONT'; debounceTimeInMilli?: number }

CapturePhotoResult

{ imageBase64: string }

PermissionsResult

{ camera: 'prompt' | 'denied' | 'granted' }

BarcodeScannedEvent

{ scannedCode: string; format: string }

Enums

BarcodeFormat