feat: support complete WebUSB device properties #47459
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
erickzhao
reviewed
Jun 18, 2025
docs/api/structures/usb-device.md
Outdated
Comment on lines
5
to
18
| * `configurationName` String - the name provided by the device to describe this configuration. | ||
| * `interfaces` Object[] - An array of [USBInterface](https://developer.mozilla.org/en-US/docs/Web/API/USBInterface) objects containing information about an interface provided by the USB device. | ||
| * `interfaceNumber` Integer - the interface number of this interface. | ||
| * `alternate` Object - the currently selected alternative configuration of this interface. | ||
| * `alternateSetting` Integer - the alternate setting number of this interface. | ||
| * `interfaceClass` Integer - the class of this interface. See [USB.org](https://www.usb.org/defined-class-codes) for class code descriptions. | ||
| * `interfaceSubclass` Integer - the subclass of this interface. | ||
| * `interfaceProtocol` Integer - the protocol supported by this interface. | ||
| * `interfaceName` String (optional) - the name of the interface, if one is provided by the device. | ||
| * `endpoints` Object[] - an array containing instances of the [USBEndpoint interface](https://developer.mozilla.org/en-US/docs/Web/API/USBEndpoint) describing each of the endpoints that are part of this interface. | ||
| * `endpointNumber` Integer - this endpoint's "endpoint number" which is a value from 1 to 15. | ||
| * `direction` String - the direction in which this endpoint transfers data - can be either 'in' or 'out'. | ||
| * `type` String - the type of this endpoint - can be either 'bulk', 'interrupt', or 'isochronous'. | ||
| * `packetSize` Number - the size of the packets that data sent through this endpoint will be divided into. |
There was a problem hiding this comment.
We don't have a unified standard in the API docs for this yet (ref electron/docs-parser#144) but can we stick to either String or string for the raw type within this structure?
There was a problem hiding this comment.
There's a no-wrapper-object-types rule for ESLint that encourages use of string over String (as well as number over Number, etc.)
Seems worthwhile to conform to that recommendation even if we don't have an easy way to enforce it directly.
There was a problem hiding this comment.
The referenced electron/docs-parser PR will enforce it, albeit not in the most user friendly way (by the time the error is thrown, things like line number info aren't available).
407bd77 to
3c4fdc3
Compare
|
Release Notes Persisted
|
kigh-ota
pushed a commit
to kigh-ota/electron
that referenced
this pull request
Sep 30, 2025
* feat: support complete WebUSB device properties * docs: correct type consistency
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description of Change
Similar vein as #47391 - we should expose the full property set of [
USBDevice] per spec.Checklist
npm testpassesRelease Notes
Notes: Added support for
USBDevice.configurations.