Interface PixelScannerOptions

Available options for usePixelScannerNotify.

interface PixelScannerOptions {
    autoStart?: boolean;
    minUpdateInterval?: number;
    scanFilter?: ((scannedPixel) => boolean);
}

Properties

autoStart? minUpdateInterval? scanFilter?

Properties

Optional autoStart

autoStart?: boolean

If true, the scanner will start automatically on mount.

Default

true.

Optional minUpdateInterval

minUpdateInterval?: number

Minimum interval in milliseconds between two React state updates. A value of 0 will generate a state update on every scan event.

Default

200 ms.

Optional scanFilter

scanFilter?: ((scannedPixel) => boolean)

Optional filter to only keep certain Pixels in the list.

Type declaration

    • (scannedPixel): boolean

    • Optional filter to only keep certain Pixels in the list.

      Parameters

      Returns boolean

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc