don/cordova-plugin-ble-central

Document interface BLEScanOptions

GerardoPrototype opened this issue · 3 comments

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

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

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;
}

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.