USB | Node WebUSB

USB class

Type parameters

T

Hierarchy

TypedDispatcher
- USB

Implements

W3CUSB

Index

Constructors

constructor

Accessors

Methods

Constructors

constructor

new USB(options?: USBOptions): USB

USB constructor

Parameters
- Optional options: USBOptions
  
  USB initialisation options
Returns USB

Accessors

onconnect

set onconnect(fn: function): void

Parameters
- fn: function
  - - (ev: USBConnectionEvent): void
    - Parameters
      - ev: USBConnectionEvent
      Returns void
Returns void

ondisconnect

set ondisconnect(fn: function): void

Parameters
- fn: function
  - - (ev: USBConnectionEvent): void
    - Parameters
      - ev: USBConnectionEvent
      Returns void
Returns void

Methods

addEventListener

addEventListener<K>(type: K, listener: function): void

Inherited from TypedDispatcher.addEventListener

Type parameters
- K: keyof T
Parameters
- type: K
- listener: function
  - - (this: this, event: T[K]): void
    - Parameters
      - this: this
      - event: T[K]
      Returns void
Returns void

addEventListener<E>(type: E, listener: function): void

Inherited from TypedDispatcher.addEventListener

Type parameters
- E: keyof EventListeners<T>
Parameters
- type: E
- listener: function
  - - (this: this, event: EventListeners<T>[E]): void
    - Parameters
      - this: this
      - event: EventListeners<T>[E]
      Returns void
Returns void

addListener

addListener<K>(event: K, listener: function): this

Inherited from TypedDispatcher.addListener

Type parameters
- K: keyof T
Parameters
- event: K
- listener: function
  - - (data: T[K]): void
    - Parameters
      - data: T[K]
      Returns void
Returns this

addListener<E>(event: E, listener: function): this

Inherited from TypedDispatcher.addListener

Type parameters
- E: keyof EventListeners<T>
Parameters
- event: E
- listener: function
  - - (data: EventListeners<T>[E]): void
    - Parameters
      - data: EventListeners<T>[E]
      Returns void
Returns this

dispatchEvent

dispatchEvent<K>(event: T[K]): boolean

Inherited from TypedDispatcher.dispatchEvent

Type parameters
- K: keyof T
Parameters
- event: T[K]
Returns boolean

emit

emit<K>(event: K, data: T[K]): boolean

Inherited from TypedDispatcher.emit

Type parameters
- K: keyof T
Parameters
- event: K
- data: T[K]
Returns boolean

eventNames

eventNames<K, E>(): Array<K | E>

Inherited from TypedDispatcher.eventNames

Type parameters
- K: keyof T
- E: keyof EventListeners<T>
Returns Array<K | E>

getDevices

getDevices(): Promise<Array<USBDevice>>

Gets all allowed Web USB devices which are connected

Returns Promise<Array<USBDevice>>

Promise containing an array of devices

getMaxListeners

getMaxListeners(): number

Inherited from TypedDispatcher.getMaxListeners

Returns number

listenerCount

listenerCount<K>(type: K): number

Inherited from TypedDispatcher.listenerCount

Type parameters
- K: keyof T
Parameters
- type: K
Returns number

listenerCount<E>(type: EventListeners<T>[E]): number

Inherited from TypedDispatcher.listenerCount

Type parameters
- E: keyof EventListeners<T>
Parameters
- type: EventListeners<T>[E]
Returns number

listeners

listeners<K>(event: K): Array<Function>

Inherited from TypedDispatcher.listeners

Type parameters
- K: keyof T
Parameters
- event: K
Returns Array<Function>

listeners<E>(event: EventListeners<T>[E]): Array<Function>

Inherited from TypedDispatcher.listeners

Type parameters
- E: keyof EventListeners<T>
Parameters
- event: EventListeners<T>[E]
Returns Array<Function>

on

on<K>(event: K, listener: function): this

Inherited from TypedDispatcher.on

Type parameters
- K: keyof T
Parameters
- event: K
- listener: function
  - - (data: T[K]): void
    - Parameters
      - data: T[K]
      Returns void
Returns this

on<E>(event: E, listener: function): this

Inherited from TypedDispatcher.on

Type parameters
- E: keyof EventListeners<T>
Parameters
- event: E
- listener: function
  - - (data: EventListeners<T>[E]): void
    - Parameters
      - data: EventListeners<T>[E]
      Returns void
Returns this

once

once<K>(event: K, listener: function): this

Inherited from TypedDispatcher.once

Type parameters
- K: keyof T
Parameters
- event: K
- listener: function
  - - (data: T[K]): void
    - Parameters
      - data: T[K]
      Returns void
Returns this

once<E>(event: E, listener: function): this

Inherited from TypedDispatcher.once

Type parameters
- E: keyof EventListeners<T>
Parameters
- event: E
- listener: function
  - - (data: EventListeners<T>[E]): void
    - Parameters
      - data: EventListeners<T>[E]
      Returns void
Returns this

prependListener

prependListener<K>(event: K, listener: function): this

Inherited from TypedDispatcher.prependListener

Type parameters
- K: keyof T
Parameters
- event: K
- listener: function
  - - (data: T[K]): void
    - Parameters
      - data: T[K]
      Returns void
Returns this

prependOnceListener

prependOnceListener<K>(event: K, listener: function): this

Inherited from TypedDispatcher.prependOnceListener

Type parameters
- K: keyof T
Parameters
- event: K
- listener: function
  - - (data: T[K]): void
    - Parameters
      - data: T[K]
      Returns void
Returns this

removeAllListeners

removeAllListeners<K>(event?: K): this

Inherited from TypedDispatcher.removeAllListeners

Type parameters
- K: keyof T
Parameters
- Optional event: K
Returns this

removeAllListeners<E>(event?: E): this

Inherited from TypedDispatcher.removeAllListeners

Type parameters
- E: keyof EventListeners<T>
Parameters
- Optional event: E
Returns this

removeEventListener

removeEventListener<K>(type: K, callback: function): void

Inherited from TypedDispatcher.removeEventListener

Type parameters
- K: keyof T
Parameters
- type: K
- callback: function
  - - (this: this, event: T[K]): void
    - Parameters
      - this: this
      - event: T[K]
      Returns void
Returns void

removeEventListener<E>(type: E, callback: function): void

Inherited from TypedDispatcher.removeEventListener

Type parameters
- E: keyof EventListeners<T>
Parameters
- type: E
- callback: function
  - - (this: this, event: EventListeners<T>[E]): void
    - Parameters
      - this: this
      - event: EventListeners<T>[E]
      Returns void
Returns void

removeListener

removeListener<K>(event: K, listener: function): this

Inherited from TypedDispatcher.removeListener

Type parameters
- K: keyof T
Parameters
- event: K
- listener: function
  - - (data: T[K]): void
    - Parameters
      - data: T[K]
      Returns void
Returns this

removeListener<E>(event: E, listener: function): this

Inherited from TypedDispatcher.removeListener

Type parameters
- E: keyof EventListeners<T>
Parameters
- event: E
- listener: function
  - - (data: EventListeners<T>[E]): void
    - Parameters
      - data: EventListeners<T>[E]
      Returns void
Returns this

requestDevice

requestDevice(options: USBDeviceRequestOptions): Promise<USBDevice>

Requests a single Web USB device

Parameters
- options: USBDeviceRequestOptions
  
  The options to use when scanning
Returns Promise<USBDevice>

Promise containing the selected device

setMaxListeners

setMaxListeners(n: number): this

Inherited from TypedDispatcher.setMaxListeners

Parameters
- n: number
Returns this