@types/web-bluetooth
Advanced tools
@types/web-bluetooth provides TypeScript definitions for the Web Bluetooth API, allowing developers to interact with Bluetooth devices from web applications with type safety and autocompletion.
Requesting a Bluetooth Device
This feature allows you to request a Bluetooth device that offers a specific service, in this case, the 'battery_service'. The code demonstrates how to request the device and handle the response or any errors.
navigator.bluetooth.requestDevice({ filters: [{ services: ['battery_service'] }] })
.then(device => console.log(device.name))
.catch(error => console.error(error));Connecting to a GATT Server
This feature allows you to connect to the GATT (Generic Attribute Profile) server of a Bluetooth device. The code demonstrates how to request a device and then connect to its GATT server.
navigator.bluetooth.requestDevice({ filters: [{ services: ['battery_service'] }] })
.then(device => device.gatt.connect())
.then(server => console.log('Connected to GATT Server'))
.catch(error => console.error(error));Reading a Characteristic Value
This feature allows you to read a characteristic value from a Bluetooth device. The code demonstrates how to request a device, connect to its GATT server, get the primary service, get the characteristic, and read its value.
navigator.bluetooth.requestDevice({ filters: [{ services: ['battery_service'] }] })
.then(device => device.gatt.connect())
.then(server => server.getPrimaryService('battery_service'))
.then(service => service.getCharacteristic('battery_level'))
.then(characteristic => characteristic.readValue())
.then(value => console.log('Battery level is ' + value.getUint8(0) + '%'))
.catch(error => console.error(error));Noble is a Node.js library for interfacing with Bluetooth devices. Unlike @types/web-bluetooth, which is designed for web applications, Noble is intended for use in Node.js environments and provides more extensive support for Bluetooth Low Energy (BLE) operations.
The web-bluetooth package is a polyfill for the Web Bluetooth API, allowing you to use the same API in environments where it is not natively supported. It provides similar functionalities to @types/web-bluetooth but is aimed at broader compatibility.
npm install --save @types/web-bluetooth
This package contains type definitions for Web Bluetooth (https://webbluetoothcg.github.io/web-bluetooth/).
Files were exported from https://www.github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/web-bluetooth
Additional Details
These definitions were written by Uri Shaked https://github.com/urish.
FAQs
TypeScript definitions for web-bluetooth
The npm package @types/web-bluetooth receives a total of 289,074 weekly downloads. As such, @types/web-bluetooth popularity was classified as popular.
We found that @types/web-bluetooth demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
PyPI now supports digital attestations, enhancing security and trust by allowing package maintainers to verify the authenticity of Python packages.
Security News
GitHub removed 27 malicious pull requests attempting to inject harmful code across multiple open source repositories, in another round of low-effort attacks.
Security News
RubyGems.org has added a new "maintainer" role that allows for publishing new versions of gems. This new permission type is aimed at improving security for gem owners and the service overall.