Credenza3 Scanner Library

Installation

with npm

npm install @credenza3/scanner-lib

with yarn

yarn add @credenza3/scanner-lib

with pnpm

pnpm install @credenza3/scanner-lib

or include a script tag

<script src="https://unpkg.com/@credenza3/scanner-lib/dist/scanner.umd.js"></script>

Usage

import {Scanner} from '@credenza3/scanner-lib'

or

const Scanner = window.CredenzaScanner

Create an instance of Credenza scanner

const scanner = new Scanner({target: '.scanner-placeholder'}) // query selector to render the scanner into.

Static

Scanner.events - list of events produced by scanner

Scan

scanner.scan({
  deviceId?: string,
  isCloseButton?: boolean
  maxScansPerSecond? number // 25
}) 

Cancel

scanner.close()

Events

On capture

//         'capture'
scanner.on(Scanner.events.CAPTURE, ({ rawString, message, scanType, sub, format, raw }: { rawString: string, message: string, scanType?: string, sub?: string, format: string, raw?: string }) => {

  // if format is JSON, then sub, aud, scanType are available
  if (format === 'JSON') {
    console.log('Scan completed', { rawString, message, sub, format, scanType });
  } else { // if format is RAW_TEXT only rawString and raw are available
    console.log('Scan completed', { rawString, format, raw });
  }
})

On error

//         'error'
scanner.on(Scanner.events.ERROR, (err) => {
  console.log('Scan error:', err)
})

On cancel

//         'cancel'
scanner.on(Scanner.events.CAPTURE, () => {
  console.log('Scan canceled')
})

DEMO