Class ScanOptions

Helper class for getting/setting scan options.

Any changes (i.e. calls to ScanOptions.setValue) return a new class instance.

Index

Constructors

`Protected`constructor

new ScanOptions(lib: LibSANE, opts: ScanOption<any>[]): ScanOptions
Parameters
- lib: LibSANE
- opts: ScanOption<any>[]
Returns ScanOptions
Inherited from ScanOptionsBase.constructor
- Defined in src/options.ts:102

Properties

`Protected`_lib

_lib: LibSANE

`Readonly`brX

brX: ScanOption<number> | null = null

Well-known SANE option br-x.

See

https://sane-project.gitlab.io/standard/1.06/api.html#well-known-options

`Readonly`brY

brY: ScanOption<number> | null = null

Well-known SANE option br-y.

See

https://sane-project.gitlab.io/standard/1.06/api.html#well-known-options

`Readonly`options

options: readonly ScanOption<any>[]

List of all SANE options.

`Readonly`preview

preview: ScanOption<boolean> | null = null

Well-known SANE option preview.

See

https://sane-project.gitlab.io/standard/1.06/api.html#well-known-options

`Readonly`resolution

resolution: ScanOption<number> | null = null

Well-known SANE option resolution.

See

https://sane-project.gitlab.io/standard/1.06/api.html#well-known-options

`Readonly`tlX

tlX: ScanOption<number> | null = null

Well-known SANE option tl-x.

See

https://sane-project.gitlab.io/standard/1.06/api.html#well-known-options

`Readonly`tlY

tlY: ScanOption<number> | null = null

Well-known SANE option tl-y.

See

https://sane-project.gitlab.io/standard/1.06/api.html#well-known-options

`Readonly`zero

zero: ScanOption<number>

Well-known SANE option index zero (total number of options).

See

https://sane-project.gitlab.io/standard/1.06/api.html#well-known-options

Methods

`Protected`_setOpts

_setOpts(
    this: {
        brX: ScanOption<number> | null;
        brY: ScanOption<number> | null;
        options: readonly ScanOption<any>[];
        preview: ScanOption<boolean> | null;
        resolution: ScanOption<number> | null;
        tlX: ScanOption<number> | null;
        tlY: ScanOption<number> | null;
        zero: ScanOption<number>;
        "[iterator]"(): IterableIterator<ScanOption<any>>;
        setValue(index: number, value: any): any;
    },
    opts: ScanOption<any>[],
): void
Parameters
- this: {
      brX: ScanOption<number> | null;
      brY: ScanOption<number> | null;
      options: readonly ScanOption<any>[];
      preview: ScanOption<boolean> | null;
      resolution: ScanOption<number> | null;
      tlX: ScanOption<number> | null;
      tlY: ScanOption<number> | null;
      zero: ScanOption<number>;
      "[iterator]"(): IterableIterator<ScanOption<any>>;
      setValue(index: number, value: any): any;
  }
  - ReadonlybrX: ScanOption<number> | null
    
    Well-known SANE option br-x.
    
    See
    https://sane-project.gitlab.io/standard/1.06/api.html#well-known-options
  - ReadonlybrY: ScanOption<number> | null
    
    Well-known SANE option br-y.
    
    See
    https://sane-project.gitlab.io/standard/1.06/api.html#well-known-options
  - Readonlyoptions: readonly ScanOption<any>[]
    
    List of all SANE options.
  - Readonlypreview: ScanOption<boolean> | null
    
    Well-known SANE option preview.
    
    See
    https://sane-project.gitlab.io/standard/1.06/api.html#well-known-options
  - Readonlyresolution: ScanOption<number> | null
    
    Well-known SANE option resolution.
    
    See
    https://sane-project.gitlab.io/standard/1.06/api.html#well-known-options
  - ReadonlytlX: ScanOption<number> | null
    
    Well-known SANE option tl-x.
    
    See
    https://sane-project.gitlab.io/standard/1.06/api.html#well-known-options
  - ReadonlytlY: ScanOption<number> | null
    
    Well-known SANE option tl-y.
    
    See
    https://sane-project.gitlab.io/standard/1.06/api.html#well-known-options
  - Readonlyzero: ScanOption<number>
    
    Well-known SANE option index zero (total number of options).
    
    See
    https://sane-project.gitlab.io/standard/1.06/api.html#well-known-options
  - [iterator]: function
    
    "[iterator]"(): IterableIterator<ScanOption<any>>
    
    Returns IterableIterator<ScanOption<any>>
    
    Defined in src/options.ts:73
  - setValue: function
    
    setValue(index: number, value: any): any
    
    Set option value. Use null as value for automatic.
    
    Parameters
    
    index: number
    
    value: any
    
    Returns any
    
    See
    https://sane-project.gitlab.io/standard/1.06/api.html#sane-control-option
    
    Defined in src/options.ts:163
- opts: ScanOption<any>[]
Returns void
Inherited from ScanOptionsBase._setOpts
- Defined in src/options.ts:107

`Protected`_setValue

_setValue(
    index: number,
    value: any,
): Promise<
    | {
        info: null;
        opts: null;
        status: | UNSUPPORTED
        | CANCELLED
        | DEVICE_BUSY
        | INVAL
        | EOF
        | JAMMED
        | NO_DOCS
        | COVER_OPEN
        | IO_ERROR
        | NO_MEM
        | ACCESS_DENIED;
    }
    | { info: SANEInfo; opts: ScanOption<any>[]; status: GOOD },
>
Parameters
- index: number
- value: any
Returns Promise<
    | {
        info: null;
        opts: null;
        status: | UNSUPPORTED
        | CANCELLED
        | DEVICE_BUSY
        | INVAL
        | EOF
        | JAMMED
        | NO_DOCS
        | COVER_OPEN
        | IO_ERROR
        | NO_MEM
        | ACCESS_DENIED;
    }
    | { info: SANEInfo; opts: ScanOption<any>[]; status: GOOD },
>
Inherited from ScanOptionsBase._setValue
- Defined in src/options.ts:125

[iterator]

"[iterator]"(): IterableIterator<ScanOption<any>>
Returns IterableIterator<ScanOption<any>>
Inherited from ScanOptionsBase.[iterator]
- Defined in src/options.ts:73

setValue

setValue(
    index: number,
    value: any,
): Promise<
    | { info: SANEInfo; status: GOOD; updated: ScanOptions }
    | {
        info: null;
        status:
            | UNSUPPORTED
            | CANCELLED
            | DEVICE_BUSY
            | INVAL
            | EOF
            | JAMMED
            | NO_DOCS
            | COVER_OPEN
            | IO_ERROR
            | NO_MEM
            | ACCESS_DENIED;
        updated: null;
    },
>
Set option value. Use null as value for automatic.
Parameters
- index: number
- value: any
Returns Promise<
    | { info: SANEInfo; status: GOOD; updated: ScanOptions }
    | {
        info: null;
        status:
            | UNSUPPORTED
            | CANCELLED
            | DEVICE_BUSY
            | INVAL
            | EOF
            | JAMMED
            | NO_DOCS
            | COVER_OPEN
            | IO_ERROR
            | NO_MEM
            | ACCESS_DENIED;
        updated: null;
    },
>

See
https://sane-project.gitlab.io/standard/1.06/api.html#sane-control-option
Overrides ScanOptionsBase.setValue
- Defined in src/options.ts:201

`Protected` `Static`_getOpts

_getOpts(lib: LibSANE): Promise<ScanOption<any>[]>
Parameters
- lib: LibSANE
Returns Promise<ScanOption<any>[]>
Inherited from ScanOptionsBase._getOpts
- Defined in src/options.ts:77

`Static`get

get(lib: LibSANE): Promise<ScanOptions>
Get class instance (with all scanning options).
Parameters
- lib: LibSANE
Returns Promise<ScanOptions>
Overrides ScanOptionsBase.get
- Defined in src/options.ts:197

Class ScanOptions

Index

Constructors

Properties

Methods

Constructors

Protectedconstructor

Parameters

Returns ScanOptions

Properties

Protected_lib

ReadonlybrX

See

ReadonlybrY

See

Readonlyoptions

Readonlypreview

See

Readonlyresolution

See

ReadonlytlX

See

ReadonlytlY

See

Readonlyzero

See

Methods

Protected_setOpts

Parameters

ReadonlybrX: ScanOption<number> | null

See

ReadonlybrY: ScanOption<number> | null

See

Readonlyoptions: readonly ScanOption<any>[]

Readonlypreview: ScanOption<boolean> | null

See

Readonlyresolution: ScanOption<number> | null

See

ReadonlytlX: ScanOption<number> | null

See

ReadonlytlY: ScanOption<number> | null

See

Readonlyzero: ScanOption<number>

See

[iterator]: function

Returns IterableIterator<ScanOption<any>>

setValue: function

Parameters

Returns any

See

Returns void

Protected_setValue

Parameters

Returns Promise< | { info: null; opts: null; status: | UNSUPPORTED | CANCELLED | DEVICE_BUSY | INVAL | EOF | JAMMED | NO_DOCS | COVER_OPEN | IO_ERROR | NO_MEM | ACCESS_DENIED; } | { info: SANEInfo; opts: ScanOption<any>[]; status: GOOD },>

[iterator]

Returns IterableIterator<ScanOption<any>>

setValue

Parameters

Returns Promise< | { info: SANEInfo; status: GOOD; updated: ScanOptions } | { info: null; status: | UNSUPPORTED | CANCELLED | DEVICE_BUSY | INVAL | EOF | JAMMED | NO_DOCS | COVER_OPEN | IO_ERROR | NO_MEM | ACCESS_DENIED; updated: null; },>

See

Protected Static_getOpts

Parameters

Returns Promise<ScanOption<any>[]>

Staticget

Parameters

Returns Promise<ScanOptions>

Settings

On This Page

`Protected`constructor

`Protected`_lib

`Readonly`brX

`Readonly`brY

`Readonly`options

`Readonly`preview

`Readonly`resolution

`Readonly`tlX

`Readonly`tlY

`Readonly`zero

`Protected`_setOpts

`Readonly`brX: ScanOption<number> | null

`Readonly`brY: ScanOption<number> | null

`Readonly`options: readonly ScanOption<any>[]

`Readonly`preview: ScanOption<boolean> | null

`Readonly`resolution: ScanOption<number> | null

`Readonly`tlX: ScanOption<number> | null

`Readonly`tlY: ScanOption<number> | null

`Readonly`zero: ScanOption<number>

`Protected`_setValue

Returns Promise<
| {
info: null;
opts: null;
status: | UNSUPPORTED
| CANCELLED
| DEVICE_BUSY
| INVAL
| EOF
| JAMMED
| NO_DOCS
| COVER_OPEN
| IO_ERROR
| NO_MEM
| ACCESS_DENIED;
}
| { info: SANEInfo; opts: ScanOption<any>[]; status: GOOD },
>

Returns Promise<
| { info: SANEInfo; status: GOOD; updated: ScanOptions }
| {
info: null;
status:
| UNSUPPORTED
| CANCELLED
| DEVICE_BUSY
| INVAL
| EOF
| JAMMED
| NO_DOCS
| COVER_OPEN
| IO_ERROR
| NO_MEM
| ACCESS_DENIED;
updated: null;
},
>

`Protected` `Static`_getOpts

`Static`get