Class WebUSB

Implements

USB

Index

Constructors

Properties

authorisedDevices emitter knownDevices

Accessors

onconnect ondisconnect

Methods

addEventListener dispatchEvent getDevices removeEventListener requestDevice

Constructors

constructor

new WebUSB(options?): WebUSB
Parameters
- options: USBOptions = {}
Returns WebUSB
- Defined in tsc/webusb/index.ts:54

Properties

`Protected` authorisedDevices

authorisedDevices: Set<USBDeviceFilter> = ...

`Protected` emitter

emitter: EventEmitter<DefaultEventMap> = ...

`Protected` knownDevices

knownDevices: Map<Device, WebUSBDevice> = ...

Accessors

onconnect

set onconnect(fn): void
Parameters
- fn: ((ev) => void)
  - - (ev): void
    - Parameters
      ev: USBConnectionEvent
      Returns void
Returns void
Implementation of USB.onconnect
- Defined in tsc/webusb/index.ts:115

ondisconnect

set ondisconnect(fn): void
Parameters
- fn: ((ev) => void)
  - - (ev): void
    - Parameters
      ev: USBConnectionEvent
      Returns void
Returns void
Implementation of USB.ondisconnect
- Defined in tsc/webusb/index.ts:128

Methods

addEventListener

addEventListener(type, listener): void
Parameters
- type: "connect" | "disconnect"
- listener: ((this, ev) => void)
  - - (this, ev): void
    - Parameters
      this: this
      ev: USBConnectionEvent
      Returns void
Returns void
Implementation of USB.addEventListener
- Defined in tsc/webusb/index.ts:140
addEventListener(type, listener): void
Parameters
- type: "connect" | "disconnect"
- listener: EventListener
Returns void
Implementation of USB.addEventListener
- Defined in tsc/webusb/index.ts:141

dispatchEvent

dispatchEvent(_event): boolean
Parameters
- _event: Event
Returns boolean
Implementation of USB.dispatchEvent
- Defined in tsc/webusb/index.ts:152

getDevices

getDevices(): Promise<USBDevice[]>
Gets all allowed Web USB devices which are connected

Returns Promise<USBDevice[]>
Promise containing an array of devices
Implementation of USB.getDevices
- Defined in tsc/webusb/index.ts:230

removeEventListener

removeEventListener(type, callback): void
Parameters
- type: "connect" | "disconnect"
- callback: ((this, ev) => void)
  - - (this, ev): void
    - Parameters
      this: this
      ev: USBConnectionEvent
      Returns void
Returns void
Implementation of USB.removeEventListener
- Defined in tsc/webusb/index.ts:146
removeEventListener(type, callback): void
Parameters
- type: "connect" | "disconnect"
- callback: EventListener
Returns void
Implementation of USB.removeEventListener
- Defined in tsc/webusb/index.ts:147

requestDevice

requestDevice(options?): Promise<USBDevice>
Requests a single Web USB device
Parameters
- Optional options: USBDeviceRequestOptions
  The options to use when scanning
Returns Promise<USBDevice>
Promise containing the selected device
Implementation of USB.requestDevice
- Defined in tsc/webusb/index.ts:162