modules.md

qr-scanner-cli / Exports

qr-scanner-cli

Table of contents

Type aliases

• Flags

Functions

• scanFromFile

Type aliases

Flags

Ƭ Flags: { clear?: boolean ; clipboard?: boolean ; open?: boolean }

Type declaration:

Name	Type
clear?	boolean
clipboard?	boolean
open?	boolean

Defined in: cli/flags.ts:13

Functions

scanFromFile

▸ ConstscanFromFile(filePath: string, flags?: Flags): Promise<string>

This function reads a file, get it's bitmap, searches and read a qrcode from it.

const value = await scanFromFile('./image.jpg')

Parameters:

Name	Type	Description
filePath	string	A file path for an image file containing a QR Code
flags?	Flags

Returns: Promise<string>

Value read from the QR Code inside the image

Defined in: pipelines/scanFromFile.ts:17