Interface LibSANE

The core SANE Emscripten module.

Hierarchy

LibSANE

Properties

SANE_CONSTRAINT

SANE_CONSTRAINT: SANEEnum<typeof SANEConstraintType, SANEConstraintType>

Deprecated

Consider using the SANEConstraintType enum directly.

This object is not going away anytime soon (or ever probably).

But you should consider using the equivalent enum because it doesn't require having a reference to the library module. All enums are exported with the package.

SANE_CURRENT_MAJOR

SANE_CURRENT_MAJOR: number

SANE API version code (major).

See

https://sane-project.gitlab.io/standard/1.06/api.html#version-control

SANE_CURRENT_MINOR

SANE_CURRENT_MINOR: number

SANE API version code (minor).

See

https://sane-project.gitlab.io/standard/1.06/api.html#version-control

SANE_FRAME

SANE_FRAME: SANEEnum<typeof SANEFrame, SANEFrame>

Deprecated

Consider using the SANEFrame enum directly.

This object is not going away anytime soon (or ever probably).

But you should consider using the equivalent enum because it doesn't require having a reference to the library module. All enums are exported with the package.

SANE_STATUS

SANE_STATUS: SANEEnum<typeof SANEStatus, SANEStatus>

Deprecated

Consider using the SANEStatus enum directly.

This object is not going away anytime soon (or ever probably).

But you should consider using the equivalent enum because it doesn't require having a reference to the library module. All enums are exported with the package.

SANE_TYPE

SANE_TYPE: SANEEnum<typeof SANEValueType, SANEValueType>

Deprecated

Consider using the SANEValueType enum directly.

This object is not going away anytime soon (or ever probably).

But you should consider using the equivalent enum because it doesn't require having a reference to the library module. All enums are exported with the package.

SANE_UNIT

SANE_UNIT: SANEEnum<typeof SANEUnit, SANEUnit>

Deprecated

Consider using the SANEUnit enum directly.

This object is not going away anytime soon (or ever probably).

But you should consider using the equivalent enum because it doesn't require having a reference to the library module. All enums are exported with the package.

SANE_WASM_BACKENDS

SANE_WASM_BACKENDS: string

List of SANE API backends built into sane-wasm.

SANE_WASM_COMMIT

SANE_WASM_COMMIT: string

Commit hash of sane-wasm.

SANE_WASM_VERSION

SANE_WASM_VERSION: string

Version code of sane-wasm.

sane_cancel

sane_cancel: (() => Promise<{
status: SANEStatus;
}>)

Type declaration

- (): Promise<{
  status: SANEStatus;
  }>
- Equivalent to the SANE API C function sane_cancel.
  
  Returns Promise<{
  status: SANEStatus;
  }>
  
  See
  https://sane-project.gitlab.io/standard/1.06/api.html#sane-cancel

sane_close

sane_close: (() => Promise<{
status: SANEStatus;
}>)

Type declaration

- (): Promise<{
  status: SANEStatus;
  }>
- Equivalent to the SANE API C function sane_close.
  
  Returns Promise<{
  status: SANEStatus;
  }>
  
  See
  https://sane-project.gitlab.io/standard/1.06/api.html#sane-close

sane_control_option_get_value

sane_control_option_get_value: ((option) => Promise<{
    status: GOOD;
    value: any;
} | {
    status: UNSUPPORTED | CANCELLED | DEVICE_BUSY | INVAL | EOF | JAMMED | NO_DOCS | COVER_OPEN | IO_ERROR | NO_MEM | ACCESS_DENIED;
    value: null;
}>)

Type declaration

- (option): Promise<{
      status: GOOD;
      value: any;
  } | {
      status: UNSUPPORTED | CANCELLED | DEVICE_BUSY | INVAL | EOF | JAMMED | NO_DOCS | COVER_OPEN | IO_ERROR | NO_MEM | ACCESS_DENIED;
      value: null;
  }>
- Equivalent to the SANE API C function sane_control_option.
  
  With a = SANE_ACTION_GET_VALUE (get option value).
  Parameters
  - option: number
  Returns Promise<{
      status: GOOD;
      value: any;
  } | {
      status: UNSUPPORTED | CANCELLED | DEVICE_BUSY | INVAL | EOF | JAMMED | NO_DOCS | COVER_OPEN | IO_ERROR | NO_MEM | ACCESS_DENIED;
      value: null;
  }>
  
  See
  https://sane-project.gitlab.io/standard/1.06/api.html#sane-control-option

sane_control_option_set_auto

sane_control_option_set_auto: ((option) => Promise<{
    info: SANEInfo;
    status: GOOD;
} | {
    info: null;
    status: UNSUPPORTED | CANCELLED | DEVICE_BUSY | INVAL | EOF | JAMMED | NO_DOCS | COVER_OPEN | IO_ERROR | NO_MEM | ACCESS_DENIED;
}>)

Type declaration

- (option): Promise<{
      info: SANEInfo;
      status: GOOD;
  } | {
      info: null;
      status: UNSUPPORTED | CANCELLED | DEVICE_BUSY | INVAL | EOF | JAMMED | NO_DOCS | COVER_OPEN | IO_ERROR | NO_MEM | ACCESS_DENIED;
  }>
- Equivalent to the SANE API C function sane_control_option.
  
  With a = SANE_ACTION_SET_AUTO (set option automatic).
  Parameters
  - option: number
  Returns Promise<{
      info: SANEInfo;
      status: GOOD;
  } | {
      info: null;
      status: UNSUPPORTED | CANCELLED | DEVICE_BUSY | INVAL | EOF | JAMMED | NO_DOCS | COVER_OPEN | IO_ERROR | NO_MEM | ACCESS_DENIED;
  }>
  
  See
  https://sane-project.gitlab.io/standard/1.06/api.html#sane-control-option

sane_control_option_set_value

sane_control_option_set_value: ((option, value) => Promise<{
    info: SANEInfo;
    status: GOOD;
} | {
    info: null;
    status: UNSUPPORTED | CANCELLED | DEVICE_BUSY | INVAL | EOF | JAMMED | NO_DOCS | COVER_OPEN | IO_ERROR | NO_MEM | ACCESS_DENIED;
}>)

Type declaration

- (option, value): Promise<{
      info: SANEInfo;
      status: GOOD;
  } | {
      info: null;
      status: UNSUPPORTED | CANCELLED | DEVICE_BUSY | INVAL | EOF | JAMMED | NO_DOCS | COVER_OPEN | IO_ERROR | NO_MEM | ACCESS_DENIED;
  }>
- Equivalent to the SANE API C function sane_control_option.
  
  With a = SANE_ACTION_SET_VALUE (set option value).
  Parameters
  - option: number
  - value: any
  Returns Promise<{
      info: SANEInfo;
      status: GOOD;
  } | {
      info: null;
      status: UNSUPPORTED | CANCELLED | DEVICE_BUSY | INVAL | EOF | JAMMED | NO_DOCS | COVER_OPEN | IO_ERROR | NO_MEM | ACCESS_DENIED;
  }>
  
  See
  https://sane-project.gitlab.io/standard/1.06/api.html#sane-control-option

sane_exit

sane_exit: (() => Promise<{
status: SANEStatus;
}>)

Type declaration

- (): Promise<{
  status: SANEStatus;
  }>
- Equivalent to the SANE API C function sane_exit.
  
  Returns Promise<{
  status: SANEStatus;
  }>
  
  See
  https://sane-project.gitlab.io/standard/1.06/api.html#sane-exit

sane_get_devices

sane_get_devices: (() => Promise<{
    devices: SANEDevice[];
    status: GOOD;
} | {
    devices: null;
    status: UNSUPPORTED | CANCELLED | DEVICE_BUSY | INVAL | EOF | JAMMED | NO_DOCS | COVER_OPEN | IO_ERROR | NO_MEM | ACCESS_DENIED;
}>)

Type declaration

- (): Promise<{
      devices: SANEDevice[];
      status: GOOD;
  } | {
      devices: null;
      status: UNSUPPORTED | CANCELLED | DEVICE_BUSY | INVAL | EOF | JAMMED | NO_DOCS | COVER_OPEN | IO_ERROR | NO_MEM | ACCESS_DENIED;
  }>
- Equivalent to the SANE API C function sane_get_devices.
  
  Returns Promise<{
      devices: SANEDevice[];
      status: GOOD;
  } | {
      devices: null;
      status: UNSUPPORTED | CANCELLED | DEVICE_BUSY | INVAL | EOF | JAMMED | NO_DOCS | COVER_OPEN | IO_ERROR | NO_MEM | ACCESS_DENIED;
  }>
  
  See
  https://sane-project.gitlab.io/standard/1.06/api.html#sane-get-devices

sane_get_option_descriptor

sane_get_option_descriptor: ((option) => {
option_descriptor: null | SANEOptionDescriptor;
status: SANEStatus;
})

Type declaration

- (option): {
  option_descriptor: null | SANEOptionDescriptor;
  status: SANEStatus;
  }
- Equivalent to the SANE API C function sane_get_option_descriptor.
  
  The result option_descriptor can be null even with status = SANEStatus.GOOD, it signals invalid option index.
  Parameters
  - option: number
  Returns {
  option_descriptor: null | SANEOptionDescriptor;
  status: SANEStatus;
  }
  - option_descriptor: null | SANEOptionDescriptor
  - status: SANEStatus
  See
  https://sane-project.gitlab.io/standard/1.06/api.html#sane-get-option-descriptor

sane_get_parameters

sane_get_parameters: (() => {
    parameters: SANEParameters;
    status: GOOD;
} | {
    parameters: null;
    status: UNSUPPORTED | CANCELLED | DEVICE_BUSY | INVAL | EOF | JAMMED | NO_DOCS | COVER_OPEN | IO_ERROR | NO_MEM | ACCESS_DENIED;
})

Type declaration

- (): {
      parameters: SANEParameters;
      status: GOOD;
  } | {
      parameters: null;
      status: UNSUPPORTED | CANCELLED | DEVICE_BUSY | INVAL | EOF | JAMMED | NO_DOCS | COVER_OPEN | IO_ERROR | NO_MEM | ACCESS_DENIED;
  }
- Equivalent to the SANE API C function sane_get_parameters.
  
  Returns {
      parameters: SANEParameters;
      status: GOOD;
  } | {
      parameters: null;
      status: UNSUPPORTED | CANCELLED | DEVICE_BUSY | INVAL | EOF | JAMMED | NO_DOCS | COVER_OPEN | IO_ERROR | NO_MEM | ACCESS_DENIED;
  }
  
  See
  https://sane-project.gitlab.io/standard/1.06/api.html#sane-get-parameters

sane_get_state

sane_get_state: (() => SANEState)

Type declaration

- (): SANEState
- Get the current state of the library.
  
  This is provided by sane-wasm, it's not part of SANE API.
  
  Returns SANEState

sane_init

sane_init: (() => {
    status: GOOD;
    version_code: number;
} | {
    status: UNSUPPORTED | CANCELLED | DEVICE_BUSY | INVAL | EOF | JAMMED | NO_DOCS | COVER_OPEN | IO_ERROR | NO_MEM | ACCESS_DENIED;
    version_code: null;
})

Type declaration

- (): {
      status: GOOD;
      version_code: number;
  } | {
      status: UNSUPPORTED | CANCELLED | DEVICE_BUSY | INVAL | EOF | JAMMED | NO_DOCS | COVER_OPEN | IO_ERROR | NO_MEM | ACCESS_DENIED;
      version_code: null;
  }
- Equivalent to the SANE API C function sane_init.
  
  Returns {
      status: GOOD;
      version_code: number;
  } | {
      status: UNSUPPORTED | CANCELLED | DEVICE_BUSY | INVAL | EOF | JAMMED | NO_DOCS | COVER_OPEN | IO_ERROR | NO_MEM | ACCESS_DENIED;
      version_code: null;
  }
  
  See
  https://sane-project.gitlab.io/standard/1.06/api.html#sane-init

sane_open

sane_open: ((devicename) => Promise<{
status: SANEStatus;
}>)

Type declaration

- (devicename): Promise<{
  status: SANEStatus;
  }>
- Equivalent to the SANE API C function sane_open.
  Parameters
  - devicename: string
  Returns Promise<{
  status: SANEStatus;
  }>
  
  See
  https://sane-project.gitlab.io/standard/1.06/api.html#sane-open

sane_read

sane_read: (() => Promise<{
    data: Uint8Array;
    status: GOOD;
} | {
    data: null;
    status: UNSUPPORTED | CANCELLED | DEVICE_BUSY | INVAL | EOF | JAMMED | NO_DOCS | COVER_OPEN | IO_ERROR | NO_MEM | ACCESS_DENIED;
}>)

Type declaration

- (): Promise<{
      data: Uint8Array;
      status: GOOD;
  } | {
      data: null;
      status: UNSUPPORTED | CANCELLED | DEVICE_BUSY | INVAL | EOF | JAMMED | NO_DOCS | COVER_OPEN | IO_ERROR | NO_MEM | ACCESS_DENIED;
  }>
- Equivalent to the SANE API C function sane_read.
  
  Returns Promise<{
      data: Uint8Array;
      status: GOOD;
  } | {
      data: null;
      status: UNSUPPORTED | CANCELLED | DEVICE_BUSY | INVAL | EOF | JAMMED | NO_DOCS | COVER_OPEN | IO_ERROR | NO_MEM | ACCESS_DENIED;
  }>
  
  See
  https://sane-project.gitlab.io/standard/1.06/api.html#sane-read

sane_start

sane_start: (() => {
status: SANEStatus;
})

Type declaration

- (): {
  status: SANEStatus;
  }
- Equivalent to the SANE API C function sane_start.
  
  Returns {
  status: SANEStatus;
  }
  - status: SANEStatus
  See
  https://sane-project.gitlab.io/standard/1.06/api.html#sane-start

sane_strstatus

sane_strstatus: ((status) => string)

Type declaration

- (status): string
- Equivalent to the SANE API C function sane_strstatus.
  Parameters
  - status: SANEStatus
  Returns string
  
  See
  https://sane-project.gitlab.io/standard/1.06/api.html#sane-strstatus

Interface LibSANE

Hierarchy

Index

Properties

Properties

SANE_CONSTRAINT

Deprecated

SANE_CURRENT_MAJOR

See

SANE_CURRENT_MINOR

See

SANE_FRAME

Deprecated

SANE_STATUS

Deprecated

SANE_TYPE

Deprecated

SANE_UNIT

Deprecated

SANE_WASM_BACKENDS

SANE_WASM_COMMIT

SANE_WASM_VERSION

sane_cancel

Type declaration

Returns Promise<{ status: SANEStatus; }>

See

sane_close

Type declaration

Returns Promise<{ status: SANEStatus; }>

See

sane_control_option_get_value

Type declaration

Parameters

option: number

Returns Promise<{ status: GOOD; value: any; } | { status: UNSUPPORTED | CANCELLED | DEVICE_BUSY | INVAL | EOF | JAMMED | NO_DOCS | COVER_OPEN | IO_ERROR | NO_MEM | ACCESS_DENIED; value: null; }>

See

sane_control_option_set_auto

Type declaration

Parameters

option: number

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

See

sane_control_option_set_value

Type declaration

Parameters

option: number

value: any

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

See

sane_exit

Type declaration

Returns Promise<{ status: SANEStatus; }>

See

sane_get_devices

Type declaration

Returns Promise<{ devices: SANEDevice[]; status: GOOD; } | { devices: null; status: UNSUPPORTED | CANCELLED | DEVICE_BUSY | INVAL | EOF | JAMMED | NO_DOCS | COVER_OPEN | IO_ERROR | NO_MEM | ACCESS_DENIED; }>

See

sane_get_option_descriptor

Type declaration

Parameters

option: number

Returns { option_descriptor: null | SANEOptionDescriptor; status: SANEStatus; }

option_descriptor: null | SANEOptionDescriptor

status: SANEStatus

See

sane_get_parameters

Type declaration

Returns { parameters: SANEParameters; status: GOOD; } | { parameters: null; status: UNSUPPORTED | CANCELLED | DEVICE_BUSY | INVAL | EOF | JAMMED | NO_DOCS | COVER_OPEN | IO_ERROR | NO_MEM | ACCESS_DENIED; }

See

sane_get_state

Type declaration

Returns SANEState

sane_init

Type declaration

Returns { status: GOOD; version_code: number; } | { status: UNSUPPORTED | CANCELLED | DEVICE_BUSY | INVAL | EOF | JAMMED | NO_DOCS | COVER_OPEN | IO_ERROR | NO_MEM | ACCESS_DENIED; version_code: null; }

See

sane_open

Type declaration

Parameters

devicename: string

Returns Promise<{
status: SANEStatus;
}>

Returns Promise<{
status: SANEStatus;
}>

Returns Promise<{
status: GOOD;
value: any;
} | {
status: UNSUPPORTED | CANCELLED | DEVICE_BUSY | INVAL | EOF | JAMMED | NO_DOCS | COVER_OPEN | IO_ERROR | NO_MEM | ACCESS_DENIED;
value: null;
}>

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

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

Returns Promise<{
status: SANEStatus;
}>

Returns Promise<{
devices: SANEDevice[];
status: GOOD;
} | {
devices: null;
status: UNSUPPORTED | CANCELLED | DEVICE_BUSY | INVAL | EOF | JAMMED | NO_DOCS | COVER_OPEN | IO_ERROR | NO_MEM | ACCESS_DENIED;
}>

Returns {
option_descriptor: null | SANEOptionDescriptor;
status: SANEStatus;
}

Returns {
parameters: SANEParameters;
status: GOOD;
} | {
parameters: null;
status: UNSUPPORTED | CANCELLED | DEVICE_BUSY | INVAL | EOF | JAMMED | NO_DOCS | COVER_OPEN | IO_ERROR | NO_MEM | ACCESS_DENIED;
}

Returns {
status: GOOD;
version_code: number;
} | {
status: UNSUPPORTED | CANCELLED | DEVICE_BUSY | INVAL | EOF | JAMMED | NO_DOCS | COVER_OPEN | IO_ERROR | NO_MEM | ACCESS_DENIED;
version_code: null;
}

Returns Promise<{
status: SANEStatus;
}>

Returns Promise<{
data: Uint8Array;
status: GOOD;
} | {
data: null;
status: UNSUPPORTED | CANCELLED | DEVICE_BUSY | INVAL | EOF | JAMMED | NO_DOCS | COVER_OPEN | IO_ERROR | NO_MEM | ACCESS_DENIED;
}>

Returns {
status: SANEStatus;
}