BarcodeReader is the primary interface of the STRICH SDK.


  • BarcodeReader



detected?: ((detections) => void)

Type declaration

    • (detections): void
    • User-supplied barcode detection handler.

      This is a synchronous call, so further processing will not happen until the handler returns.


      Returns void

onError?: ((error) => void)

Type declaration

    • (error): void
    • Optional user-supplied error callback.

      This is invoked by the BarcodeReader if an error occurred while processing frames, and is usually not recoverable.


      • error: Error

      Returns void


  • Destroy this BarcodeReader instance, making it unusable.

    This will release all associated resources, and should be called whenever an application no longer needs to scan.

    Returns void

  • Returns boolean

    the current visibility of this BarcodeReader instance

  • Initialize the BarcodeReader instance.

    Returns Promise<BarcodeReader>

    A promise resolving to an initialized BarcodeReader instance, or an error object.

  • Show/hide the BarcodeReader instance.


    • visible: boolean

      True/false for visible/hidden

    Returns Promise<void>

  • Start scanning for barcodes.

    Returns Promise<void>

  • Stop the BarcodeReader instance.

    This will temporarily suspend processing of camera frames / detection of codes.

    Returns Promise<void>

Generated using TypeDoc