Skip to main content

Html5QrcodeFullConfig

html5-qrcode / Html5QrcodeFullConfig

Interface: Html5QrcodeFullConfig

Interface for full configuration of Html5Qrcode.

Notes: Ideally we don't need to have two interfaces for this purpose, but since the public APIs before version 2.0.8 allowed passing a boolean verbose flag to constructor we need to allow users to pass Html5QrcodeFullConfig or boolean flag to be backward compatible. In future versions these two interfaces can be merged.

Hierarchy​

  • Html5QrcodeConfigs

    ↳ Html5QrcodeFullConfig

Table of contents​

Properties​

Properties​

experimentalFeatures​

• Optional experimentalFeatures: ExperimentalFeaturesConfig

Config for experimental features.

Everything is false by default.

Inherited from​

Html5QrcodeConfigs.experimentalFeatures

Defined in​

html5-qrcode.ts:104

formatsToSupport​

• Optional formatsToSupport: Html5QrcodeSupportedFormats[]

Array of formats to support of type Html5QrcodeSupportedFormats.

All invalid values would be ignored. If null or underfined all supported formats will be used for scanning. Unless you want to limit the scan to only certain formats or want to improve performance, you should not set this value.

Inherited from​

Html5QrcodeConfigs.formatsToSupport

Defined in​

html5-qrcode.ts:83

useBarCodeDetectorIfSupported​

• Optional useBarCodeDetectorIfSupported: boolean

BarcodeDetector is being implemented by browsers at the moment. It has very limited browser support but as it gets available it could enable faster native code scanning experience.

Set this flag to true, to enable using BarcodeDetector if supported. This is true by default.

Documentations:

Inherited from​

Html5QrcodeConfigs.useBarCodeDetectorIfSupported

Defined in​

html5-qrcode.ts:97

verbose​

• verbose: undefined | boolean

If true, all logs would be printed to console. False by default.

Defined in​

html5-qrcode.ts:120