Class ScanDataReader<T>

Raw data reader that automatically handles SANE's read code flow.

Use ScanDataReader.on to listen to events, available event types are declared on ScanDataReaderEventMap.

A device should already be open with sane_open(), the reader will call sane_start() do the scanning and call sane_stop().

Other SANE functions cannot be used while scanning.

Scan readers are single use.

https://sane-project.gitlab.io/standard/1.06/api.html#code-flow

Type Parameters

T extends ScanDataReaderEventMap = ScanDataReaderEventMap

Hierarchy (View Summary)

EventBaseClass<T>
- ScanDataReader
  - ScanImageReader

Index

Constructors

Methods

cancel fire on start

Constructors

constructor

new ScanDataReader<T extends ScanDataReaderEventMap = ScanDataReaderEventMap>(
lib: LibSANE,
): ScanDataReader<T>
Type Parameters
- T extends ScanDataReaderEventMap = ScanDataReaderEventMap
Parameters
- lib: LibSANE
Returns ScanDataReader<T>
Overrides EventBaseClass<T>.constructor
- Defined in src/readers.ts:77

Methods

cancel

cancel(): void
Cancel scanning operation.

Returns void
- Defined in src/readers.ts:182

`Protected`fire

fire<K extends string | number | symbol>(
type: K,
...args: T[K],
): Promise<null> | null
Fire event.
Type Parameters
- K extends string | number | symbol
Parameters
- type: K
- ...args: T[K]
Returns Promise<null> | null
Inherited from EventBaseClass.fire
- Defined in src/readers.ts:23

on

on<K extends string | number | symbol>(
type: K,
listener: (...args: T[K]) => void,
): void
Add event listener.
Type Parameters
- K extends string | number | symbol
Parameters
- type: K
- listener: (...args: T[K]) => void
Returns void
Inherited from EventBaseClass.on
- Defined in src/readers.ts:13

start

start(): Promise<
    | {
        parameters: null;
        promise: Promise<void>;
        status:
            | UNSUPPORTED
            | CANCELLED
            | DEVICE_BUSY
            | INVAL
            | EOF
            | JAMMED
            | NO_DOCS
            | COVER_OPEN
            | IO_ERROR
            | NO_MEM
            | ACCESS_DENIED;
    }
    | { parameters: SANEParameters; promise: Promise<void>; status: GOOD },
>
Start scanning operation.

Returns Promise<
    | {
        parameters: null;
        promise: Promise<void>;
        status:
            | UNSUPPORTED
            | CANCELLED
            | DEVICE_BUSY
            | INVAL
            | EOF
            | JAMMED
            | NO_DOCS
            | COVER_OPEN
            | IO_ERROR
            | NO_MEM
            | ACCESS_DENIED;
    }
    | { parameters: SANEParameters; promise: Promise<void>; status: GOOD },
>
- Defined in src/readers.ts:136