don / cordova-plugin-ble-central

Bluetooth Low Energy (BLE) Central plugin for Apache Cordova (aka PhoneGap)
Apache License 2.0
941 stars 601 forks source link

Document interface BLEScanOptions #990

Closed GerardoPrototype closed 7 months ago

GerardoPrototype commented 7 months ago

First of all, thank you very much for the work you do with this plugins <3.

I just wanted to mention if the options for this method work "startScanWithOptions".

I saw that the BLEScanOptions interface was missing some fields. I don't know much about git to create a pull request. I think it's just add them.

thank you very much

peitschie commented 7 months ago

@GerardoPrototype if you can paste the updated docs or types you think are missing here, I'm happy to add them in! 🙂

GerardoPrototype commented 7 months ago

I think I was wrong, the typos are in the @awesome-cordova-plugins/ble/ngx but I think these are the ones that should be according to the documentation

interface BLEScanOptions { reportDuplicates?: boolean; duration?: number; scanMode?: 'lowPower' | 'balanced' | 'lowLatency' | 'opportunistic'; callbackType?: 'all' | 'first' | 'lost'; matchMode?: 'aggressive' | 'sticky'; numOfMatches?: 'one' | 'few' | 'max' phy?: '1m' | 'coded' | 'all' legacy?: boolean; forceScanFilter?: boolean; reportDelay?: number; }

peitschie commented 7 months ago

Right! Yeah... I am not a maintainer on that wrapper, so you are best to raise the issue on their github site over at https://github.com/danielsogl/awesome-cordova-plugins

What you've documented here is correct based of the type definitions this repo has though.