Class WebUSB

Hierarchy

EventTarget
- WebUSB

Implements

USB

Index

Constructors

Properties

authorisedDevices knownDevices nativeEmitter

Accessors

onconnect ondisconnect

Methods

addEventListener getDevices removeEventListener requestDevice

Constructors

constructor

new WebUSB(options?: USBOptions): WebUSB
Parameters
- options: USBOptions = {}
Returns WebUSB
- Defined in index.ts:141

Properties

`Protected`authorisedDevices

authorisedDevices: Set<USBDeviceFilter> = ...

`Protected`knownDevices

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

`Protected`nativeEmitter

nativeEmitter: Emitter = ...

Accessors

onconnect

set onconnect(fn: (ev: USBConnectionEvent) => void): void
Parameters
- fn: (ev: USBConnectionEvent) => void
Returns void
- Defined in index.ts:172

ondisconnect

set ondisconnect(fn: (ev: USBConnectionEvent) => void): void
Parameters
- fn: (ev: USBConnectionEvent) => void
Returns void
- Defined in index.ts:185

Methods

addEventListener

addEventListener(
    type: "connect" | "disconnect",
    listener: (this: this, ev: USBConnectionEvent) => any,
    useCapture?: boolean,
): void
Parameters
- type: "connect" | "disconnect"
- listener: (this: this, ev: USBConnectionEvent) => any
- OptionaluseCapture: boolean
Returns void
- Defined in index.ts:113
addEventListener(
    type: string,
    listener: EventListenerOrEventListenerObject | null,
    options?: boolean | AddEventListenerOptions,
): void
Parameters
- type: string
- listener: EventListenerOrEventListenerObject | null
- Optionaloptions: boolean | AddEventListenerOptions
Returns void
- Defined in index.ts:118

getDevices

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

Returns Promise<USBDevice[]>
Promise containing an array of devices
- Defined in index.ts:270

removeEventListener

removeEventListener(
    type: "connect" | "disconnect",
    callback: (this: this, ev: USBConnectionEvent) => any,
    useCapture?: boolean,
): void
Parameters
- type: "connect" | "disconnect"
- callback: (this: this, ev: USBConnectionEvent) => any
- OptionaluseCapture: boolean
Returns void
- Defined in index.ts:123
removeEventListener(
    type: string,
    callback: EventListenerOrEventListenerObject | null,
    options?: boolean | EventListenerOptions,
): void
Parameters
- type: string
- callback: EventListenerOrEventListenerObject | null
- Optionaloptions: boolean | EventListenerOptions
Returns void
- Defined in index.ts:128

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
- Defined in index.ts:202