Class WebUSB

WebUSB class

Events

Name	Event	Description
`connect`	USBConnectionEvent	Device connected
`disconnect`	USBConnectionEvent	Device disconnected

Hierarchy

EventTarget
- WebUSB

Implements

Index

Constructors

constructor

new WebUSB(options?: USBOptions): WebUSB
Parameters
- options: USBOptions = {}
Returns WebUSB
Overrides EventTarget.constructor
- Defined in index.ts:142

Properties

`Protected`authorisedDevices

authorisedDevices: Set<USBDeviceFilter> = ...

`Protected`knownDevices

knownDevices: Map<string, UsbDevice> = ...

`Protected`listenerCount

listenerCount: number = 0

`Protected`nativeEmitter

nativeEmitter: Emitter = ...

Accessors

onconnect

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

ondisconnect

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

Methods

addEventListener

addEventListener(
type: "connect" | "disconnect",
listener: (this: this, ev: USBConnectionEvent) => void,
): void
The addEventListener() method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.

MDN Reference
Parameters
- type: "connect" | "disconnect"
- listener: (this: this, ev: USBConnectionEvent) => void
Returns void
Implementation of USB.addEventListener
Overrides EventTarget.addEventListener
- Defined in index.ts:167
addEventListener(type: "connect" | "disconnect", listener: EventListener): void
Parameters
- type: "connect" | "disconnect"
- listener: EventListener
Returns void
Implementation of USB.addEventListener
Overrides EventTarget.addEventListener
- Defined in index.ts:168

findDeviceByIds

findDeviceByIds(vid: number, pid: number): Promise<UsbDevice | undefined>
Convenience method to get the first device with the specified VID and PID, or undefined if no such device is present.
Parameters
- vid: number
- pid: number
Returns Promise<UsbDevice | undefined>
- Defined in index.ts:314

findDeviceBySerial

findDeviceBySerial(serialNumber: string): Promise<UsbDevice | undefined>
Convenience method to get the device with the specified serial number, or undefined if no such device is present.
Parameters
- serialNumber: string
Returns Promise<UsbDevice | undefined>
- Defined in index.ts:323

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 index.ts:300

removeEventListener

removeEventListener(
type: "connect" | "disconnect",
callback: (this: this, ev: USBConnectionEvent) => void,
): void
The removeEventListener() method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.

MDN Reference
Parameters
- type: "connect" | "disconnect"
- callback: (this: this, ev: USBConnectionEvent) => void
Returns void
Implementation of USB.removeEventListener
Overrides EventTarget.removeEventListener
- Defined in index.ts:184
removeEventListener(
type: "connect" | "disconnect",
callback: EventListener,
): void
Parameters
- type: "connect" | "disconnect"
- callback: EventListener
Returns void
Implementation of USB.removeEventListener
Overrides EventTarget.removeEventListener
- Defined in index.ts:185

requestDevice

requestDevice(options?: USBDeviceRequestOptions): Promise<UsbDevice>
Requests a single Web USB device
Parameters
- Optionaloptions: USBDeviceRequestOptions
  The options to use when scanning
Returns Promise<UsbDevice>
Promise containing the selected device
Implementation of USB.requestDevice
- Defined in index.ts:232

Class WebUSB

Events

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns WebUSB

Properties

ProtectedauthorisedDevices

ProtectedknownDevices

ProtectedlistenerCount

ProtectednativeEmitter

Accessors

onconnect

Parameters

Returns void

ondisconnect

Parameters

Returns void

Methods

addEventListener

Parameters

Returns void

Parameters

Returns void

findDeviceByIds

Parameters

Returns Promise<UsbDevice | undefined>

findDeviceBySerial

Parameters

Returns Promise<UsbDevice | undefined>

getDevices

Returns Promise<UsbDevice[]>

removeEventListener

Parameters

Returns void

Parameters

Returns void

requestDevice

Parameters

Returns Promise<UsbDevice>

Settings

On This Page

`Protected`authorisedDevices

`Protected`knownDevices

`Protected`listenerCount

`Protected`nativeEmitter