Skip to content

barcodeScanner

References

PermissionState

Re-exports PermissionState

Enumerations

Format

Enumeration Members

Aztec
Aztec: "AZTEC";

Codabar
Codabar: "CODABAR";

Code128
Code128: "CODE_128";

Code39
Code39: "CODE_39";

Code93
Code93: "CODE_93";

DataMatrix
DataMatrix: "DATA_MATRIX";

EAN13
EAN13: "EAN_13";

EAN8
EAN8: "EAN_8";

ITF
ITF: "ITF";

PDF417
PDF417: "PDF_417";

QRCode
QRCode: "QR_CODE";

UPC_A
UPC_A: "UPC_A";

UPC_E
UPC_E: "UPC_E";

Interfaces

Scanned

Properties

PropertyTypeDefined in
boundsunknown
contentstring
formatFormat

ScanOptions

Properties

PropertyTypeDefined in
cameraDirection?"back" | "front"
formats?Format[]
windowed?boolean

Functions

cancel()

function cancel(): Promise<void>

Cancel the current scan process.

Returns

Promise<void>


checkPermissions()

function checkPermissions(): Promise<PermissionState>

Get permission state.

Returns

Promise<PermissionState>


openAppSettings()

function openAppSettings(): Promise<void>

Open application settings. Useful if permission was denied and the user must manually enable it.

Returns

Promise<void>


requestPermissions()

function requestPermissions(): Promise<PermissionState>

Request permissions to use the camera.

Returns

Promise<PermissionState>


scan()

function scan(options?): Promise<Scanned>

Start scanning.

Parameters

ParameterTypeDescription
options?ScanOptions

Returns

Promise<Scanned>