@capacitor-community/bluetooth-le 6.1.0 → 7.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (55) hide show
  1. package/CapacitorCommunityBluetoothLe.podspec +17 -17
  2. package/LICENSE +21 -21
  3. package/README.md +97 -27
  4. package/android/build.gradle +68 -68
  5. package/android/src/main/AndroidManifest.xml +22 -22
  6. package/android/src/main/java/com/capacitorjs/community/plugins/bluetoothle/BluetoothLe.kt +1061 -1009
  7. package/android/src/main/java/com/capacitorjs/community/plugins/bluetoothle/Conversion.kt +51 -50
  8. package/android/src/main/java/com/capacitorjs/community/plugins/bluetoothle/Device.kt +720 -718
  9. package/android/src/main/java/com/capacitorjs/community/plugins/bluetoothle/DeviceList.kt +28 -28
  10. package/android/src/main/java/com/capacitorjs/community/plugins/bluetoothle/DeviceScanner.kt +189 -189
  11. package/dist/docs.json +892 -78
  12. package/dist/esm/bleClient.d.ts +277 -277
  13. package/dist/esm/bleClient.js +349 -349
  14. package/dist/esm/bleClient.js.map +1 -1
  15. package/dist/esm/config.d.ts +53 -53
  16. package/dist/esm/config.js +2 -2
  17. package/dist/esm/config.js.map +1 -1
  18. package/dist/esm/conversion.d.ts +34 -34
  19. package/dist/esm/conversion.js +84 -84
  20. package/dist/esm/conversion.js.map +1 -1
  21. package/dist/esm/definitions.d.ts +301 -292
  22. package/dist/esm/definitions.js +42 -42
  23. package/dist/esm/definitions.js.map +1 -1
  24. package/dist/esm/index.d.ts +5 -5
  25. package/dist/esm/index.js +5 -5
  26. package/dist/esm/index.js.map +1 -1
  27. package/dist/esm/plugin.d.ts +2 -2
  28. package/dist/esm/plugin.js +4 -4
  29. package/dist/esm/plugin.js.map +1 -1
  30. package/dist/esm/queue.d.ts +3 -3
  31. package/dist/esm/queue.js +17 -17
  32. package/dist/esm/queue.js.map +1 -1
  33. package/dist/esm/timeout.d.ts +1 -1
  34. package/dist/esm/timeout.js +9 -9
  35. package/dist/esm/timeout.js.map +1 -1
  36. package/dist/esm/validators.d.ts +1 -1
  37. package/dist/esm/validators.js +11 -11
  38. package/dist/esm/validators.js.map +1 -1
  39. package/dist/esm/web.d.ts +56 -56
  40. package/dist/esm/web.js +340 -335
  41. package/dist/esm/web.js.map +1 -1
  42. package/dist/plugin.cjs.js +839 -834
  43. package/dist/plugin.cjs.js.map +1 -1
  44. package/dist/plugin.js +839 -834
  45. package/dist/plugin.js.map +1 -1
  46. package/ios/Plugin/Conversion.swift +83 -74
  47. package/ios/Plugin/Device.swift +423 -423
  48. package/ios/Plugin/DeviceManager.swift +401 -349
  49. package/ios/Plugin/Info.plist +24 -24
  50. package/ios/Plugin/Logging.swift +8 -8
  51. package/ios/Plugin/Plugin.h +10 -10
  52. package/ios/Plugin/Plugin.m +41 -41
  53. package/ios/Plugin/Plugin.swift +682 -636
  54. package/ios/Plugin/ThreadSafeDictionary.swift +13 -13
  55. package/package.json +101 -101
package/dist/docs.json CHANGED
@@ -17,7 +17,7 @@
17
17
  ],
18
18
  "returns": "Promise<void>",
19
19
  "tags": [],
20
- "docs": "Initialize Bluetooth Low Energy (BLE). If it fails, BLE might be unavailable on this device.\nOn **Android** it will ask for the location permission. On **iOS** it will ask for the Bluetooth permission.\nFor an example, see [usage](#usage).",
20
+ "docs": "Initialize Bluetooth Low Energy (BLE). If it fails, BLE might be unavailable on this device.\r\nOn **Android** it will ask for the location permission. On **iOS** it will ask for the Bluetooth permission.\r\nFor an example, see [usage](#usage).",
21
21
  "complexTypes": [
22
22
  "InitializeOptions"
23
23
  ],
@@ -29,7 +29,7 @@
29
29
  "parameters": [],
30
30
  "returns": "Promise<boolean>",
31
31
  "tags": [],
32
- "docs": "Reports whether Bluetooth is enabled on this device.\nAlways returns `true` on **web**.",
32
+ "docs": "Reports whether Bluetooth is enabled on this device.\r\nAlways returns `true` on **web**.",
33
33
  "complexTypes": [],
34
34
  "slug": "isenabled"
35
35
  },
@@ -39,7 +39,7 @@
39
39
  "parameters": [],
40
40
  "returns": "Promise<void>",
41
41
  "tags": [],
42
- "docs": "Request enabling Bluetooth. Show a system activity that allows the user to turn on Bluetooth. See https://developer.android.com/reference/android/bluetooth/BluetoothAdapter#ACTION_REQUEST_ENABLE\nOnly available on **Android**.",
42
+ "docs": "Request enabling Bluetooth. Show a system activity that allows the user to turn on Bluetooth. See https://developer.android.com/reference/android/bluetooth/BluetoothAdapter#ACTION_REQUEST_ENABLE\r\nOnly available on **Android**.",
43
43
  "complexTypes": [],
44
44
  "slug": "requestenable"
45
45
  },
@@ -54,7 +54,7 @@
54
54
  "text": "Will fail on Android SDK >= 33. Use `requestEnable` instead. See https://developer.android.com/reference/android/bluetooth/BluetoothAdapter#enable()"
55
55
  }
56
56
  ],
57
- "docs": "Enable Bluetooth.\nOnly available on **Android**.\n**Deprecated** Will fail on Android SDK >= 33. Use `requestEnable` instead. See https://developer.android.com/reference/android/bluetooth/BluetoothAdapter#enable()",
57
+ "docs": "Enable Bluetooth.\r\nOnly available on **Android**.\r\n**Deprecated** Will fail on Android SDK >= 33. Use `requestEnable` instead. See https://developer.android.com/reference/android/bluetooth/BluetoothAdapter#enable()",
58
58
  "complexTypes": [],
59
59
  "slug": "enable"
60
60
  },
@@ -69,7 +69,7 @@
69
69
  "text": "Will fail on Android SDK >= 33. See https://developer.android.com/reference/android/bluetooth/BluetoothAdapter#disable()"
70
70
  }
71
71
  ],
72
- "docs": "Disable Bluetooth.\nOnly available on **Android**.\n**Deprecated** Will fail on Android SDK >= 33. See https://developer.android.com/reference/android/bluetooth/BluetoothAdapter#disable()",
72
+ "docs": "Disable Bluetooth.\r\nOnly available on **Android**.\r\n**Deprecated** Will fail on Android SDK >= 33. See https://developer.android.com/reference/android/bluetooth/BluetoothAdapter#disable()",
73
73
  "complexTypes": [],
74
74
  "slug": "disable"
75
75
  },
@@ -90,7 +90,7 @@
90
90
  "text": "callback Callback function to use when the Bluetooth state changes."
91
91
  }
92
92
  ],
93
- "docs": "Register a callback function that will be invoked when Bluetooth is enabled (true) or disabled (false) on this device.\nNot available on **web** (the callback will never be invoked).",
93
+ "docs": "Register a callback function that will be invoked when Bluetooth is enabled (true) or disabled (false) on this device.\r\nNot available on **web** (the callback will never be invoked).",
94
94
  "complexTypes": [],
95
95
  "slug": "startenablednotifications"
96
96
  },
@@ -110,7 +110,7 @@
110
110
  "parameters": [],
111
111
  "returns": "Promise<boolean>",
112
112
  "tags": [],
113
- "docs": "Reports whether Location Services are enabled on this device.\nOnly available on **Android**.",
113
+ "docs": "Reports whether Location Services are enabled on this device.\r\nOnly available on **Android**.",
114
114
  "complexTypes": [],
115
115
  "slug": "islocationenabled"
116
116
  },
@@ -120,7 +120,7 @@
120
120
  "parameters": [],
121
121
  "returns": "Promise<void>",
122
122
  "tags": [],
123
- "docs": "Open Location settings.\nOnly available on **Android**.",
123
+ "docs": "Open Location settings.\r\nOnly available on **Android**.",
124
124
  "complexTypes": [],
125
125
  "slug": "openlocationsettings"
126
126
  },
@@ -130,7 +130,7 @@
130
130
  "parameters": [],
131
131
  "returns": "Promise<void>",
132
132
  "tags": [],
133
- "docs": "Open Bluetooth settings.\nOnly available on **Android**.",
133
+ "docs": "Open Bluetooth settings.\r\nOnly available on **Android**.",
134
134
  "complexTypes": [],
135
135
  "slug": "openbluetoothsettings"
136
136
  },
@@ -140,7 +140,7 @@
140
140
  "parameters": [],
141
141
  "returns": "Promise<void>",
142
142
  "tags": [],
143
- "docs": "Open App settings.\nNot available on **web**.\nOn **iOS** when a user declines the request to use Bluetooth on the first call of `initialize`, it is not possible\nto request for Bluetooth again from within the app. In this case Bluetooth has to be enabled in the app settings\nfor the app to be able use it.",
143
+ "docs": "Open App settings.\r\nNot available on **web**.\r\nOn **iOS** when a user declines the request to use Bluetooth on the first call of `initialize`, it is not possible\r\nto request for Bluetooth again from within the app. In this case Bluetooth has to be enabled in the app settings\r\nfor the app to be able use it.",
144
144
  "complexTypes": [],
145
145
  "slug": "openappsettings"
146
146
  },
@@ -184,7 +184,7 @@
184
184
  "text": "options Device filters, see [RequestBleDeviceOptions](#RequestBleDeviceOptions)"
185
185
  }
186
186
  ],
187
- "docs": "Request a peripheral BLE device to interact with. This will scan for available devices according to the filters in the options and show a dialog to pick a device.\nFor an example, see [usage](#usage).",
187
+ "docs": "Request a peripheral BLE device to interact with. This will scan for available devices according to the filters in the options and show a dialog to pick a device.\r\nFor an example, see [usage](#usage).",
188
188
  "complexTypes": [
189
189
  "BleDevice",
190
190
  "RequestBleDeviceOptions"
@@ -217,7 +217,7 @@
217
217
  "text": "callback"
218
218
  }
219
219
  ],
220
- "docs": "Start scanning for BLE devices to interact with according to the filters in the options. The callback will be invoked on each device that is found.\nScanning will continue until `stopLEScan` is called. For an example, see [usage](#usage).\n**Note**: Use with care on **web** platform, the required API is still behind a flag in most browsers.",
220
+ "docs": "Start scanning for BLE devices to interact with according to the filters in the options. The callback will be invoked on each device that is found.\r\nScanning will continue until `stopLEScan` is called. For an example, see [usage](#usage).\r\n**Note**: Use with care on **web** platform, the required API is still behind a flag in most browsers.",
221
221
  "complexTypes": [
222
222
  "RequestBleDeviceOptions",
223
223
  "ScanResult"
@@ -251,7 +251,7 @@
251
251
  "text": "deviceIds List of device IDs, e.g. saved from a previous app run."
252
252
  }
253
253
  ],
254
- "docs": "On iOS and web, if you want to connect to a previously connected device without scanning first, you can use `getDevice`.\nUses [retrievePeripherals](https://developer.apple.com/documentation/corebluetooth/cbcentralmanager/1519127-retrieveperipherals) on iOS and\n[getDevices](https://developer.mozilla.org/en-US/docs/Web/API/Bluetooth/getDevices) on web.\nOn Android, you can directly connect to the device with the deviceId.",
254
+ "docs": "On iOS and web, if you want to connect to a previously connected device without scanning first, you can use `getDevice`.\r\nUses [retrievePeripherals](https://developer.apple.com/documentation/corebluetooth/cbcentralmanager/1519127-retrieveperipherals) on iOS and\r\n[getDevices](https://developer.mozilla.org/en-US/docs/Web/API/Bluetooth/getDevices) on web.\r\nOn Android, you can directly connect to the device with the deviceId.",
255
255
  "complexTypes": [
256
256
  "BleDevice"
257
257
  ],
@@ -263,7 +263,7 @@
263
263
  "parameters": [],
264
264
  "returns": "Promise<BleDevice[]>",
265
265
  "tags": [],
266
- "docs": "Get a list of currently bonded devices.\nOnly available on **Android**.\nUses [getBondedDevices](https://developer.android.com/reference/android/bluetooth/BluetoothAdapter#getBondedDevices()) on Android",
266
+ "docs": "Get a list of currently bonded devices.\r\nOnly available on **Android**.\r\nUses [getBondedDevices](https://developer.android.com/reference/android/bluetooth/BluetoothAdapter#getBondedDevices()) on Android",
267
267
  "complexTypes": [
268
268
  "BleDevice"
269
269
  ],
@@ -286,7 +286,7 @@
286
286
  "text": "services List of services to filter the devices by. If no service is specified, no devices will be returned. Only applies to iOS."
287
287
  }
288
288
  ],
289
- "docs": "Get a list of currently connected devices.\nUses [retrieveConnectedPeripherals](https://developer.apple.com/documentation/corebluetooth/cbcentralmanager/1518924-retrieveconnectedperipherals) on iOS,\n[getConnectedDevices](https://developer.android.com/reference/android/bluetooth/BluetoothManager#getConnectedDevices(int)) on Android\nand [getDevices](https://developer.mozilla.org/en-US/docs/Web/API/Bluetooth/getDevices) on web.",
289
+ "docs": "Get a list of currently connected devices.\r\nUses [retrieveConnectedPeripherals](https://developer.apple.com/documentation/corebluetooth/cbcentralmanager/1518924-retrieveconnectedperipherals) on iOS,\r\n[getConnectedDevices](https://developer.android.com/reference/android/bluetooth/BluetoothManager#getConnectedDevices(int)) on Android\r\nand [getDevices](https://developer.mozilla.org/en-US/docs/Web/API/Bluetooth/getDevices) on web.",
290
290
  "complexTypes": [
291
291
  "BleDevice"
292
292
  ],
@@ -359,7 +359,7 @@
359
359
  "text": "options Options for plugin call"
360
360
  }
361
361
  ],
362
- "docs": "Create a bond with a peripheral BLE device.\nOnly available on **Android**. On iOS bonding is handled by the OS.",
362
+ "docs": "Create a bond with a peripheral BLE device.\r\nOnly available on **Android**. On iOS bonding is handled by the OS.",
363
363
  "complexTypes": [
364
364
  "TimeoutOptions"
365
365
  ],
@@ -382,7 +382,7 @@
382
382
  "text": "deviceId The ID of the device to use (obtained from [requestDevice](#requestDevice) or [requestLEScan](#requestLEScan))"
383
383
  }
384
384
  ],
385
- "docs": "Report whether a peripheral BLE device is bonded.\nOnly available on **Android**. On iOS bonding is handled by the OS.",
385
+ "docs": "Report whether a peripheral BLE device is bonded.\r\nOnly available on **Android**. On iOS bonding is handled by the OS.",
386
386
  "complexTypes": [],
387
387
  "slug": "isbonded"
388
388
  },
@@ -447,7 +447,7 @@
447
447
  "text": "deviceId The ID of the device to use (obtained from [requestDevice](#requestDevice) or [requestLEScan](#requestLEScan))"
448
448
  }
449
449
  ],
450
- "docs": "Discover services, characteristics and descriptors of a device.\nYou only need this method if your peripheral device changes its services and characteristics at runtime.\nIf the discovery was successful, the remote services can be retrieved using the getServices function.\nNot available on **web**.",
450
+ "docs": "Discover services, characteristics and descriptors of a device.\r\nYou only need this method if your peripheral device changes its services and characteristics at runtime.\r\nIf the discovery was successful, the remote services can be retrieved using the getServices function.\r\nNot available on **web**.",
451
451
  "complexTypes": [],
452
452
  "slug": "discoverservices"
453
453
  },
@@ -468,7 +468,7 @@
468
468
  "text": "deviceId The ID of the device to use (obtained from [requestDevice](#requestDevice) or [requestLEScan](#requestLEScan))"
469
469
  }
470
470
  ],
471
- "docs": "Get the MTU of a connected device. Note that the maximum write value length is 3 bytes less than the MTU.\nNot available on **web**.",
471
+ "docs": "Get the MTU of a connected device. Note that the maximum write value length is 3 bytes less than the MTU.\r\nNot available on **web**.",
472
472
  "complexTypes": [],
473
473
  "slug": "getmtu"
474
474
  },
@@ -498,7 +498,7 @@
498
498
  "text": "connectionPriority Request a specific connection priority. See [ConnectionPriority](#connectionpriority)"
499
499
  }
500
500
  ],
501
- "docs": "Request a connection parameter update.\nOnly available on **Android**. https://developer.android.com/reference/android/bluetooth/BluetoothGatt#requestConnectionPriority(int)",
501
+ "docs": "Request a connection parameter update.\r\nOnly available on **Android**. https://developer.android.com/reference/android/bluetooth/BluetoothGatt#requestConnectionPriority(int)",
502
502
  "complexTypes": [
503
503
  "ConnectionPriority"
504
504
  ],
@@ -521,7 +521,7 @@
521
521
  "text": "deviceId The ID of the device to use (obtained from [requestDevice](#requestDevice) or [requestLEScan](#requestLEScan))"
522
522
  }
523
523
  ],
524
- "docs": "Read the RSSI value of a connected device.\nNot available on **web**.",
524
+ "docs": "Read the RSSI value of a connected device.\r\nNot available on **web**.",
525
525
  "complexTypes": [],
526
526
  "slug": "readrssi"
527
527
  },
@@ -869,7 +869,7 @@
869
869
  "text": "callback Callback function to use when the value of the characteristic changes"
870
870
  }
871
871
  ],
872
- "docs": "Start listening to changes of the value of a characteristic.\nNote that you should only start the notifications once per characteristic in your app and share the data and\nnot call `startNotifications` in every component that needs the data.\nFor an example, see [usage](#usage).",
872
+ "docs": "Start listening to changes of the value of a characteristic.\r\nNote that you should only start the notifications once per characteristic in your app and share the data and\r\nnot call `startNotifications` in every component that needs the data.\r\nFor an example, see [usage](#usage).",
873
873
  "complexTypes": [
874
874
  "DataView"
875
875
  ],
@@ -933,7 +933,7 @@
933
933
  "name": "default"
934
934
  }
935
935
  ],
936
- "docs": "If your app doesn't use Bluetooth scan results to derive physical\nlocation information, you can strongly assert that your app\ndoesn't derive physical location. (Android only)\nRequires adding 'neverForLocation' to AndroidManifest.xml\nhttps://developer.android.com/guide/topics/connectivity/bluetooth/permissions#assert-never-for-location",
936
+ "docs": "If your app doesn't use Bluetooth scan results to derive physical\r\nlocation information, you can strongly assert that your app\r\ndoesn't derive physical location. (Android only)\r\nRequires adding 'neverForLocation' to AndroidManifest.xml\r\nhttps://developer.android.com/guide/topics/connectivity/bluetooth/permissions#assert-never-for-location",
937
937
  "complexTypes": [],
938
938
  "type": "boolean | undefined"
939
939
  }
@@ -1038,7 +1038,7 @@
1038
1038
  {
1039
1039
  "name": "deviceId",
1040
1040
  "tags": [],
1041
- "docs": "ID of the device, which will be needed for further calls.\nOn **Android** this is the BLE MAC address.\nOn **iOS** and **web** it is an identifier.",
1041
+ "docs": "ID of the device, which will be needed for further calls.\r\nOn **Android** this is the BLE MAC address.\r\nOn **iOS** and **web** it is an identifier.",
1042
1042
  "complexTypes": [],
1043
1043
  "type": "string"
1044
1044
  },
@@ -1068,7 +1068,7 @@
1068
1068
  {
1069
1069
  "name": "services",
1070
1070
  "tags": [],
1071
- "docs": "Filter devices by service UUIDs.\nUUIDs have to be specified as 128 bit UUID strings,\ne.g. ['0000180d-0000-1000-8000-00805f9b34fb']\nThere is a helper function to convert numbers to UUIDs.\ne.g. [numberToUUID(0x180f)]. (see [UUID format](#uuid-format))",
1071
+ "docs": "Filter devices by service UUIDs.\r\nUUIDs have to be specified as 128 bit UUID strings,\r\ne.g. ['0000180d-0000-1000-8000-00805f9b34fb']\r\nThere is a helper function to convert numbers to UUIDs.\r\ne.g. [numberToUUID(0x180f)]. (see [UUID format](#uuid-format))",
1072
1072
  "complexTypes": [],
1073
1073
  "type": "string[] | undefined"
1074
1074
  },
@@ -1089,14 +1089,14 @@
1089
1089
  {
1090
1090
  "name": "optionalServices",
1091
1091
  "tags": [],
1092
- "docs": "For **web**, all services that will be used have to be listed under services or optionalServices,\ne.g. [numberToUUID(0x180f)] (see [UUID format](#uuid-format))",
1092
+ "docs": "For **web**, all services that will be used have to be listed under services or optionalServices,\r\ne.g. [numberToUUID(0x180f)] (see [UUID format](#uuid-format))",
1093
1093
  "complexTypes": [],
1094
1094
  "type": "string[] | undefined"
1095
1095
  },
1096
1096
  {
1097
1097
  "name": "allowDuplicates",
1098
1098
  "tags": [],
1099
- "docs": "Normally scans will discard the second and subsequent advertisements from a single device.\nIf you need to receive them, set allowDuplicates to true (only applicable in `requestLEScan`).\n(default: false)",
1099
+ "docs": "Normally scans will discard the second and subsequent advertisements from a single device.\r\nIf you need to receive them, set allowDuplicates to true (only applicable in `requestLEScan`).\r\n(default: false)",
1100
1100
  "complexTypes": [],
1101
1101
  "type": "boolean | undefined"
1102
1102
  },
@@ -1108,6 +1108,846 @@
1108
1108
  "ScanMode"
1109
1109
  ],
1110
1110
  "type": "ScanMode"
1111
+ },
1112
+ {
1113
+ "name": "manufacturerData",
1114
+ "tags": [],
1115
+ "docs": "Allow scanning for devices with a specific manufacturer data\r\nhttps://developer.mozilla.org/en-US/docs/Web/API/Bluetooth/requestDevice#manufacturerdata",
1116
+ "complexTypes": [
1117
+ "Uint8Array"
1118
+ ],
1119
+ "type": "{ companyIdentifier: number; dataPrefix?: Uint8Array | undefined; mask?: Uint8Array | undefined; }[] | undefined"
1120
+ }
1121
+ ]
1122
+ },
1123
+ {
1124
+ "name": "Uint8Array",
1125
+ "slug": "uint8array",
1126
+ "docs": "A typed array of 8-bit unsigned integer values. The contents are initialized to 0. If the\r\nrequested number of bytes could not be allocated an exception is raised.",
1127
+ "tags": [],
1128
+ "methods": [
1129
+ {
1130
+ "name": "copyWithin",
1131
+ "signature": "(target: number, start: number, end?: number | undefined) => this",
1132
+ "parameters": [
1133
+ {
1134
+ "name": "target",
1135
+ "docs": "If target is negative, it is treated as length+target where length is the\r\nlength of the array.",
1136
+ "type": "number"
1137
+ },
1138
+ {
1139
+ "name": "start",
1140
+ "docs": "If start is negative, it is treated as length+start. If end is negative, it\r\nis treated as length+end.",
1141
+ "type": "number"
1142
+ },
1143
+ {
1144
+ "name": "end",
1145
+ "docs": "If not specified, length of the this object is used as its default value.",
1146
+ "type": "number | undefined"
1147
+ }
1148
+ ],
1149
+ "returns": "this",
1150
+ "tags": [
1151
+ {
1152
+ "name": "param",
1153
+ "text": "target If target is negative, it is treated as length+target where length is the\r\nlength of the array."
1154
+ },
1155
+ {
1156
+ "name": "param",
1157
+ "text": "start If start is negative, it is treated as length+start. If end is negative, it\r\nis treated as length+end."
1158
+ },
1159
+ {
1160
+ "name": "param",
1161
+ "text": "end If not specified, length of the this object is used as its default value."
1162
+ }
1163
+ ],
1164
+ "docs": "Returns the this object after copying a section of the array identified by start and end\r\nto the same array starting at position target",
1165
+ "complexTypes": [],
1166
+ "slug": "copywithin"
1167
+ },
1168
+ {
1169
+ "name": "every",
1170
+ "signature": "(predicate: (value: number, index: number, array: Uint8Array) => unknown, thisArg?: any) => boolean",
1171
+ "parameters": [
1172
+ {
1173
+ "name": "predicate",
1174
+ "docs": "A function that accepts up to three arguments. The every method calls\r\nthe predicate function for each element in the array until the predicate returns a value\r\nwhich is coercible to the Boolean value false, or until the end of the array.",
1175
+ "type": "(value: number, index: number, array: Uint8Array) => unknown"
1176
+ },
1177
+ {
1178
+ "name": "thisArg",
1179
+ "docs": "An object to which the this keyword can refer in the predicate function.\r\nIf thisArg is omitted, undefined is used as the this value.",
1180
+ "type": "any"
1181
+ }
1182
+ ],
1183
+ "returns": "boolean",
1184
+ "tags": [
1185
+ {
1186
+ "name": "param",
1187
+ "text": "predicate A function that accepts up to three arguments. The every method calls\r\nthe predicate function for each element in the array until the predicate returns a value\r\nwhich is coercible to the Boolean value false, or until the end of the array."
1188
+ },
1189
+ {
1190
+ "name": "param",
1191
+ "text": "thisArg An object to which the this keyword can refer in the predicate function.\r\nIf thisArg is omitted, undefined is used as the this value."
1192
+ }
1193
+ ],
1194
+ "docs": "Determines whether all the members of an array satisfy the specified test.",
1195
+ "complexTypes": [
1196
+ "Uint8Array"
1197
+ ],
1198
+ "slug": "every"
1199
+ },
1200
+ {
1201
+ "name": "fill",
1202
+ "signature": "(value: number, start?: number | undefined, end?: number | undefined) => this",
1203
+ "parameters": [
1204
+ {
1205
+ "name": "value",
1206
+ "docs": "value to fill array section with",
1207
+ "type": "number"
1208
+ },
1209
+ {
1210
+ "name": "start",
1211
+ "docs": "index to start filling the array at. If start is negative, it is treated as\r\nlength+start where length is the length of the array.",
1212
+ "type": "number | undefined"
1213
+ },
1214
+ {
1215
+ "name": "end",
1216
+ "docs": "index to stop filling the array at. If end is negative, it is treated as\r\nlength+end.",
1217
+ "type": "number | undefined"
1218
+ }
1219
+ ],
1220
+ "returns": "this",
1221
+ "tags": [
1222
+ {
1223
+ "name": "param",
1224
+ "text": "value value to fill array section with"
1225
+ },
1226
+ {
1227
+ "name": "param",
1228
+ "text": "start index to start filling the array at. If start is negative, it is treated as\r\nlength+start where length is the length of the array."
1229
+ },
1230
+ {
1231
+ "name": "param",
1232
+ "text": "end index to stop filling the array at. If end is negative, it is treated as\r\nlength+end."
1233
+ }
1234
+ ],
1235
+ "docs": "Returns the this object after filling the section identified by start and end with value",
1236
+ "complexTypes": [],
1237
+ "slug": "fill"
1238
+ },
1239
+ {
1240
+ "name": "filter",
1241
+ "signature": "(predicate: (value: number, index: number, array: Uint8Array) => any, thisArg?: any) => Uint8Array",
1242
+ "parameters": [
1243
+ {
1244
+ "name": "predicate",
1245
+ "docs": "A function that accepts up to three arguments. The filter method calls\r\nthe predicate function one time for each element in the array.",
1246
+ "type": "(value: number, index: number, array: Uint8Array) => any"
1247
+ },
1248
+ {
1249
+ "name": "thisArg",
1250
+ "docs": "An object to which the this keyword can refer in the predicate function.\r\nIf thisArg is omitted, undefined is used as the this value.",
1251
+ "type": "any"
1252
+ }
1253
+ ],
1254
+ "returns": "Uint8Array",
1255
+ "tags": [
1256
+ {
1257
+ "name": "param",
1258
+ "text": "predicate A function that accepts up to three arguments. The filter method calls\r\nthe predicate function one time for each element in the array."
1259
+ },
1260
+ {
1261
+ "name": "param",
1262
+ "text": "thisArg An object to which the this keyword can refer in the predicate function.\r\nIf thisArg is omitted, undefined is used as the this value."
1263
+ }
1264
+ ],
1265
+ "docs": "Returns the elements of an array that meet the condition specified in a callback function.",
1266
+ "complexTypes": [
1267
+ "Uint8Array"
1268
+ ],
1269
+ "slug": "filter"
1270
+ },
1271
+ {
1272
+ "name": "find",
1273
+ "signature": "(predicate: (value: number, index: number, obj: Uint8Array) => boolean, thisArg?: any) => number | undefined",
1274
+ "parameters": [
1275
+ {
1276
+ "name": "predicate",
1277
+ "docs": "find calls predicate once for each element of the array, in ascending\r\norder, until it finds one where predicate returns true. If such an element is found, find\r\nimmediately returns that element value. Otherwise, find returns undefined.",
1278
+ "type": "(value: number, index: number, obj: Uint8Array) => boolean"
1279
+ },
1280
+ {
1281
+ "name": "thisArg",
1282
+ "docs": "If provided, it will be used as the this value for each invocation of\r\npredicate. If it is not provided, undefined is used instead.",
1283
+ "type": "any"
1284
+ }
1285
+ ],
1286
+ "returns": "number | undefined",
1287
+ "tags": [
1288
+ {
1289
+ "name": "param",
1290
+ "text": "predicate find calls predicate once for each element of the array, in ascending\r\norder, until it finds one where predicate returns true. If such an element is found, find\r\nimmediately returns that element value. Otherwise, find returns undefined."
1291
+ },
1292
+ {
1293
+ "name": "param",
1294
+ "text": "thisArg If provided, it will be used as the this value for each invocation of\r\npredicate. If it is not provided, undefined is used instead."
1295
+ }
1296
+ ],
1297
+ "docs": "Returns the value of the first element in the array where predicate is true, and undefined\r\notherwise.",
1298
+ "complexTypes": [
1299
+ "Uint8Array"
1300
+ ],
1301
+ "slug": "find"
1302
+ },
1303
+ {
1304
+ "name": "findIndex",
1305
+ "signature": "(predicate: (value: number, index: number, obj: Uint8Array) => boolean, thisArg?: any) => number",
1306
+ "parameters": [
1307
+ {
1308
+ "name": "predicate",
1309
+ "docs": "find calls predicate once for each element of the array, in ascending\r\norder, until it finds one where predicate returns true. If such an element is found,\r\nfindIndex immediately returns that element index. Otherwise, findIndex returns -1.",
1310
+ "type": "(value: number, index: number, obj: Uint8Array) => boolean"
1311
+ },
1312
+ {
1313
+ "name": "thisArg",
1314
+ "docs": "If provided, it will be used as the this value for each invocation of\r\npredicate. If it is not provided, undefined is used instead.",
1315
+ "type": "any"
1316
+ }
1317
+ ],
1318
+ "returns": "number",
1319
+ "tags": [
1320
+ {
1321
+ "name": "param",
1322
+ "text": "predicate find calls predicate once for each element of the array, in ascending\r\norder, until it finds one where predicate returns true. If such an element is found,\r\nfindIndex immediately returns that element index. Otherwise, findIndex returns -1."
1323
+ },
1324
+ {
1325
+ "name": "param",
1326
+ "text": "thisArg If provided, it will be used as the this value for each invocation of\r\npredicate. If it is not provided, undefined is used instead."
1327
+ }
1328
+ ],
1329
+ "docs": "Returns the index of the first element in the array where predicate is true, and -1\r\notherwise.",
1330
+ "complexTypes": [
1331
+ "Uint8Array"
1332
+ ],
1333
+ "slug": "findindex"
1334
+ },
1335
+ {
1336
+ "name": "forEach",
1337
+ "signature": "(callbackfn: (value: number, index: number, array: Uint8Array) => void, thisArg?: any) => void",
1338
+ "parameters": [
1339
+ {
1340
+ "name": "callbackfn",
1341
+ "docs": "A function that accepts up to three arguments. forEach calls the\r\ncallbackfn function one time for each element in the array.",
1342
+ "type": "(value: number, index: number, array: Uint8Array) => void"
1343
+ },
1344
+ {
1345
+ "name": "thisArg",
1346
+ "docs": "An object to which the this keyword can refer in the callbackfn function.\r\nIf thisArg is omitted, undefined is used as the this value.",
1347
+ "type": "any"
1348
+ }
1349
+ ],
1350
+ "returns": "void",
1351
+ "tags": [
1352
+ {
1353
+ "name": "param",
1354
+ "text": "callbackfn A function that accepts up to three arguments. forEach calls the\r\ncallbackfn function one time for each element in the array."
1355
+ },
1356
+ {
1357
+ "name": "param",
1358
+ "text": "thisArg An object to which the this keyword can refer in the callbackfn function.\r\nIf thisArg is omitted, undefined is used as the this value."
1359
+ }
1360
+ ],
1361
+ "docs": "Performs the specified action for each element in an array.",
1362
+ "complexTypes": [
1363
+ "Uint8Array"
1364
+ ],
1365
+ "slug": "foreach"
1366
+ },
1367
+ {
1368
+ "name": "indexOf",
1369
+ "signature": "(searchElement: number, fromIndex?: number | undefined) => number",
1370
+ "parameters": [
1371
+ {
1372
+ "name": "searchElement",
1373
+ "docs": "The value to locate in the array.",
1374
+ "type": "number"
1375
+ },
1376
+ {
1377
+ "name": "fromIndex",
1378
+ "docs": "The array index at which to begin the search. If fromIndex is omitted, the\r\nsearch starts at index 0.",
1379
+ "type": "number | undefined"
1380
+ }
1381
+ ],
1382
+ "returns": "number",
1383
+ "tags": [
1384
+ {
1385
+ "name": "param",
1386
+ "text": "searchElement The value to locate in the array."
1387
+ },
1388
+ {
1389
+ "name": "param",
1390
+ "text": "fromIndex The array index at which to begin the search. If fromIndex is omitted, the\r\nsearch starts at index 0."
1391
+ }
1392
+ ],
1393
+ "docs": "Returns the index of the first occurrence of a value in an array.",
1394
+ "complexTypes": [],
1395
+ "slug": "indexof"
1396
+ },
1397
+ {
1398
+ "name": "join",
1399
+ "signature": "(separator?: string | undefined) => string",
1400
+ "parameters": [
1401
+ {
1402
+ "name": "separator",
1403
+ "docs": "A string used to separate one element of an array from the next in the\r\nresulting String. If omitted, the array elements are separated with a comma.",
1404
+ "type": "string | undefined"
1405
+ }
1406
+ ],
1407
+ "returns": "string",
1408
+ "tags": [
1409
+ {
1410
+ "name": "param",
1411
+ "text": "separator A string used to separate one element of an array from the next in the\r\nresulting String. If omitted, the array elements are separated with a comma."
1412
+ }
1413
+ ],
1414
+ "docs": "Adds all the elements of an array separated by the specified separator string.",
1415
+ "complexTypes": [],
1416
+ "slug": "join"
1417
+ },
1418
+ {
1419
+ "name": "lastIndexOf",
1420
+ "signature": "(searchElement: number, fromIndex?: number | undefined) => number",
1421
+ "parameters": [
1422
+ {
1423
+ "name": "searchElement",
1424
+ "docs": "The value to locate in the array.",
1425
+ "type": "number"
1426
+ },
1427
+ {
1428
+ "name": "fromIndex",
1429
+ "docs": "The array index at which to begin the search. If fromIndex is omitted, the\r\nsearch starts at index 0.",
1430
+ "type": "number | undefined"
1431
+ }
1432
+ ],
1433
+ "returns": "number",
1434
+ "tags": [
1435
+ {
1436
+ "name": "param",
1437
+ "text": "searchElement The value to locate in the array."
1438
+ },
1439
+ {
1440
+ "name": "param",
1441
+ "text": "fromIndex The array index at which to begin the search. If fromIndex is omitted, the\r\nsearch starts at index 0."
1442
+ }
1443
+ ],
1444
+ "docs": "Returns the index of the last occurrence of a value in an array.",
1445
+ "complexTypes": [],
1446
+ "slug": "lastindexof"
1447
+ },
1448
+ {
1449
+ "name": "map",
1450
+ "signature": "(callbackfn: (value: number, index: number, array: Uint8Array) => number, thisArg?: any) => Uint8Array",
1451
+ "parameters": [
1452
+ {
1453
+ "name": "callbackfn",
1454
+ "docs": "A function that accepts up to three arguments. The map method calls the\r\ncallbackfn function one time for each element in the array.",
1455
+ "type": "(value: number, index: number, array: Uint8Array) => number"
1456
+ },
1457
+ {
1458
+ "name": "thisArg",
1459
+ "docs": "An object to which the this keyword can refer in the callbackfn function.\r\nIf thisArg is omitted, undefined is used as the this value.",
1460
+ "type": "any"
1461
+ }
1462
+ ],
1463
+ "returns": "Uint8Array",
1464
+ "tags": [
1465
+ {
1466
+ "name": "param",
1467
+ "text": "callbackfn A function that accepts up to three arguments. The map method calls the\r\ncallbackfn function one time for each element in the array."
1468
+ },
1469
+ {
1470
+ "name": "param",
1471
+ "text": "thisArg An object to which the this keyword can refer in the callbackfn function.\r\nIf thisArg is omitted, undefined is used as the this value."
1472
+ }
1473
+ ],
1474
+ "docs": "Calls a defined callback function on each element of an array, and returns an array that\r\ncontains the results.",
1475
+ "complexTypes": [
1476
+ "Uint8Array"
1477
+ ],
1478
+ "slug": "map"
1479
+ },
1480
+ {
1481
+ "name": "reduce",
1482
+ "signature": "(callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: Uint8Array) => number) => number",
1483
+ "parameters": [
1484
+ {
1485
+ "name": "callbackfn",
1486
+ "docs": "A function that accepts up to four arguments. The reduce method calls the\r\ncallbackfn function one time for each element in the array.",
1487
+ "type": "(previousValue: number, currentValue: number, currentIndex: number, array: Uint8Array) => number"
1488
+ }
1489
+ ],
1490
+ "returns": "number",
1491
+ "tags": [
1492
+ {
1493
+ "name": "param",
1494
+ "text": "callbackfn A function that accepts up to four arguments. The reduce method calls the\r\ncallbackfn function one time for each element in the array."
1495
+ },
1496
+ {
1497
+ "name": "param",
1498
+ "text": "initialValue If initialValue is specified, it is used as the initial value to start\r\nthe accumulation. The first call to the callbackfn function provides this value as an argument\r\ninstead of an array value."
1499
+ }
1500
+ ],
1501
+ "docs": "Calls the specified callback function for all the elements in an array. The return value of\r\nthe callback function is the accumulated result, and is provided as an argument in the next\r\ncall to the callback function.",
1502
+ "complexTypes": [
1503
+ "Uint8Array"
1504
+ ],
1505
+ "slug": "reduce"
1506
+ },
1507
+ {
1508
+ "name": "reduce",
1509
+ "signature": "(callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: Uint8Array) => number, initialValue: number) => number",
1510
+ "parameters": [
1511
+ {
1512
+ "name": "callbackfn",
1513
+ "docs": "",
1514
+ "type": "(previousValue: number, currentValue: number, currentIndex: number, array: Uint8Array) => number"
1515
+ },
1516
+ {
1517
+ "name": "initialValue",
1518
+ "docs": "",
1519
+ "type": "number"
1520
+ }
1521
+ ],
1522
+ "returns": "number",
1523
+ "tags": [],
1524
+ "docs": "",
1525
+ "complexTypes": [
1526
+ "Uint8Array"
1527
+ ],
1528
+ "slug": "reduce"
1529
+ },
1530
+ {
1531
+ "name": "reduce",
1532
+ "signature": "<U>(callbackfn: (previousValue: U, currentValue: number, currentIndex: number, array: Uint8Array) => U, initialValue: U) => U",
1533
+ "parameters": [
1534
+ {
1535
+ "name": "callbackfn",
1536
+ "docs": "A function that accepts up to four arguments. The reduce method calls the\r\ncallbackfn function one time for each element in the array.",
1537
+ "type": "(previousValue: U, currentValue: number, currentIndex: number, array: Uint8Array) => U"
1538
+ },
1539
+ {
1540
+ "name": "initialValue",
1541
+ "docs": "If initialValue is specified, it is used as the initial value to start\r\nthe accumulation. The first call to the callbackfn function provides this value as an argument\r\ninstead of an array value.",
1542
+ "type": "U"
1543
+ }
1544
+ ],
1545
+ "returns": "U",
1546
+ "tags": [
1547
+ {
1548
+ "name": "param",
1549
+ "text": "callbackfn A function that accepts up to four arguments. The reduce method calls the\r\ncallbackfn function one time for each element in the array."
1550
+ },
1551
+ {
1552
+ "name": "param",
1553
+ "text": "initialValue If initialValue is specified, it is used as the initial value to start\r\nthe accumulation. The first call to the callbackfn function provides this value as an argument\r\ninstead of an array value."
1554
+ }
1555
+ ],
1556
+ "docs": "Calls the specified callback function for all the elements in an array. The return value of\r\nthe callback function is the accumulated result, and is provided as an argument in the next\r\ncall to the callback function.",
1557
+ "complexTypes": [
1558
+ "U",
1559
+ "Uint8Array"
1560
+ ],
1561
+ "slug": "reduce"
1562
+ },
1563
+ {
1564
+ "name": "reduceRight",
1565
+ "signature": "(callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: Uint8Array) => number) => number",
1566
+ "parameters": [
1567
+ {
1568
+ "name": "callbackfn",
1569
+ "docs": "A function that accepts up to four arguments. The reduceRight method calls\r\nthe callbackfn function one time for each element in the array.",
1570
+ "type": "(previousValue: number, currentValue: number, currentIndex: number, array: Uint8Array) => number"
1571
+ }
1572
+ ],
1573
+ "returns": "number",
1574
+ "tags": [
1575
+ {
1576
+ "name": "param",
1577
+ "text": "callbackfn A function that accepts up to four arguments. The reduceRight method calls\r\nthe callbackfn function one time for each element in the array."
1578
+ },
1579
+ {
1580
+ "name": "param",
1581
+ "text": "initialValue If initialValue is specified, it is used as the initial value to start\r\nthe accumulation. The first call to the callbackfn function provides this value as an\r\nargument instead of an array value."
1582
+ }
1583
+ ],
1584
+ "docs": "Calls the specified callback function for all the elements in an array, in descending order.\r\nThe return value of the callback function is the accumulated result, and is provided as an\r\nargument in the next call to the callback function.",
1585
+ "complexTypes": [
1586
+ "Uint8Array"
1587
+ ],
1588
+ "slug": "reduceright"
1589
+ },
1590
+ {
1591
+ "name": "reduceRight",
1592
+ "signature": "(callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: Uint8Array) => number, initialValue: number) => number",
1593
+ "parameters": [
1594
+ {
1595
+ "name": "callbackfn",
1596
+ "docs": "",
1597
+ "type": "(previousValue: number, currentValue: number, currentIndex: number, array: Uint8Array) => number"
1598
+ },
1599
+ {
1600
+ "name": "initialValue",
1601
+ "docs": "",
1602
+ "type": "number"
1603
+ }
1604
+ ],
1605
+ "returns": "number",
1606
+ "tags": [],
1607
+ "docs": "",
1608
+ "complexTypes": [
1609
+ "Uint8Array"
1610
+ ],
1611
+ "slug": "reduceright"
1612
+ },
1613
+ {
1614
+ "name": "reduceRight",
1615
+ "signature": "<U>(callbackfn: (previousValue: U, currentValue: number, currentIndex: number, array: Uint8Array) => U, initialValue: U) => U",
1616
+ "parameters": [
1617
+ {
1618
+ "name": "callbackfn",
1619
+ "docs": "A function that accepts up to four arguments. The reduceRight method calls\r\nthe callbackfn function one time for each element in the array.",
1620
+ "type": "(previousValue: U, currentValue: number, currentIndex: number, array: Uint8Array) => U"
1621
+ },
1622
+ {
1623
+ "name": "initialValue",
1624
+ "docs": "If initialValue is specified, it is used as the initial value to start\r\nthe accumulation. The first call to the callbackfn function provides this value as an argument\r\ninstead of an array value.",
1625
+ "type": "U"
1626
+ }
1627
+ ],
1628
+ "returns": "U",
1629
+ "tags": [
1630
+ {
1631
+ "name": "param",
1632
+ "text": "callbackfn A function that accepts up to four arguments. The reduceRight method calls\r\nthe callbackfn function one time for each element in the array."
1633
+ },
1634
+ {
1635
+ "name": "param",
1636
+ "text": "initialValue If initialValue is specified, it is used as the initial value to start\r\nthe accumulation. The first call to the callbackfn function provides this value as an argument\r\ninstead of an array value."
1637
+ }
1638
+ ],
1639
+ "docs": "Calls the specified callback function for all the elements in an array, in descending order.\r\nThe return value of the callback function is the accumulated result, and is provided as an\r\nargument in the next call to the callback function.",
1640
+ "complexTypes": [
1641
+ "U",
1642
+ "Uint8Array"
1643
+ ],
1644
+ "slug": "reduceright"
1645
+ },
1646
+ {
1647
+ "name": "reverse",
1648
+ "signature": "() => Uint8Array",
1649
+ "parameters": [],
1650
+ "returns": "Uint8Array",
1651
+ "tags": [],
1652
+ "docs": "Reverses the elements in an Array.",
1653
+ "complexTypes": [
1654
+ "Uint8Array"
1655
+ ],
1656
+ "slug": "reverse"
1657
+ },
1658
+ {
1659
+ "name": "set",
1660
+ "signature": "(array: ArrayLike<number>, offset?: number | undefined) => void",
1661
+ "parameters": [
1662
+ {
1663
+ "name": "array",
1664
+ "docs": "A typed or untyped array of values to set.",
1665
+ "type": "ArrayLike<number>"
1666
+ },
1667
+ {
1668
+ "name": "offset",
1669
+ "docs": "The index in the current array at which the values are to be written.",
1670
+ "type": "number | undefined"
1671
+ }
1672
+ ],
1673
+ "returns": "void",
1674
+ "tags": [
1675
+ {
1676
+ "name": "param",
1677
+ "text": "array A typed or untyped array of values to set."
1678
+ },
1679
+ {
1680
+ "name": "param",
1681
+ "text": "offset The index in the current array at which the values are to be written."
1682
+ }
1683
+ ],
1684
+ "docs": "Sets a value or an array of values.",
1685
+ "complexTypes": [
1686
+ "ArrayLike"
1687
+ ],
1688
+ "slug": "set"
1689
+ },
1690
+ {
1691
+ "name": "slice",
1692
+ "signature": "(start?: number | undefined, end?: number | undefined) => Uint8Array",
1693
+ "parameters": [
1694
+ {
1695
+ "name": "start",
1696
+ "docs": "The beginning of the specified portion of the array.",
1697
+ "type": "number | undefined"
1698
+ },
1699
+ {
1700
+ "name": "end",
1701
+ "docs": "The end of the specified portion of the array. This is exclusive of the element at the index 'end'.",
1702
+ "type": "number | undefined"
1703
+ }
1704
+ ],
1705
+ "returns": "Uint8Array",
1706
+ "tags": [
1707
+ {
1708
+ "name": "param",
1709
+ "text": "start The beginning of the specified portion of the array."
1710
+ },
1711
+ {
1712
+ "name": "param",
1713
+ "text": "end The end of the specified portion of the array. This is exclusive of the element at the index 'end'."
1714
+ }
1715
+ ],
1716
+ "docs": "Returns a section of an array.",
1717
+ "complexTypes": [
1718
+ "Uint8Array"
1719
+ ],
1720
+ "slug": "slice"
1721
+ },
1722
+ {
1723
+ "name": "some",
1724
+ "signature": "(predicate: (value: number, index: number, array: Uint8Array) => unknown, thisArg?: any) => boolean",
1725
+ "parameters": [
1726
+ {
1727
+ "name": "predicate",
1728
+ "docs": "A function that accepts up to three arguments. The some method calls\r\nthe predicate function for each element in the array until the predicate returns a value\r\nwhich is coercible to the Boolean value true, or until the end of the array.",
1729
+ "type": "(value: number, index: number, array: Uint8Array) => unknown"
1730
+ },
1731
+ {
1732
+ "name": "thisArg",
1733
+ "docs": "An object to which the this keyword can refer in the predicate function.\r\nIf thisArg is omitted, undefined is used as the this value.",
1734
+ "type": "any"
1735
+ }
1736
+ ],
1737
+ "returns": "boolean",
1738
+ "tags": [
1739
+ {
1740
+ "name": "param",
1741
+ "text": "predicate A function that accepts up to three arguments. The some method calls\r\nthe predicate function for each element in the array until the predicate returns a value\r\nwhich is coercible to the Boolean value true, or until the end of the array."
1742
+ },
1743
+ {
1744
+ "name": "param",
1745
+ "text": "thisArg An object to which the this keyword can refer in the predicate function.\r\nIf thisArg is omitted, undefined is used as the this value."
1746
+ }
1747
+ ],
1748
+ "docs": "Determines whether the specified callback function returns true for any element of an array.",
1749
+ "complexTypes": [
1750
+ "Uint8Array"
1751
+ ],
1752
+ "slug": "some"
1753
+ },
1754
+ {
1755
+ "name": "sort",
1756
+ "signature": "(compareFn?: ((a: number, b: number) => number) | undefined) => this",
1757
+ "parameters": [
1758
+ {
1759
+ "name": "compareFn",
1760
+ "docs": "Function used to determine the order of the elements. It is expected to return\r\na negative value if first argument is less than second argument, zero if they're equal and a positive\r\nvalue otherwise. If omitted, the elements are sorted in ascending, ASCII character order.\r\n```ts\r\n[11,2,22,1].sort((a, b) => a - b)\r\n```",
1761
+ "type": "((a: number, b: number) => number) | undefined"
1762
+ }
1763
+ ],
1764
+ "returns": "this",
1765
+ "tags": [
1766
+ {
1767
+ "name": "param",
1768
+ "text": "compareFn Function used to determine the order of the elements. It is expected to return\r\na negative value if first argument is less than second argument, zero if they're equal and a positive\r\nvalue otherwise. If omitted, the elements are sorted in ascending, ASCII character order.\r\n```ts\r\n[11,2,22,1].sort((a, b) => a - b)\r\n```"
1769
+ }
1770
+ ],
1771
+ "docs": "Sorts an array.",
1772
+ "complexTypes": [],
1773
+ "slug": "sort"
1774
+ },
1775
+ {
1776
+ "name": "subarray",
1777
+ "signature": "(begin?: number | undefined, end?: number | undefined) => Uint8Array",
1778
+ "parameters": [
1779
+ {
1780
+ "name": "begin",
1781
+ "docs": "The index of the beginning of the array.",
1782
+ "type": "number | undefined"
1783
+ },
1784
+ {
1785
+ "name": "end",
1786
+ "docs": "The index of the end of the array.",
1787
+ "type": "number | undefined"
1788
+ }
1789
+ ],
1790
+ "returns": "Uint8Array",
1791
+ "tags": [
1792
+ {
1793
+ "name": "param",
1794
+ "text": "begin The index of the beginning of the array."
1795
+ },
1796
+ {
1797
+ "name": "param",
1798
+ "text": "end The index of the end of the array."
1799
+ }
1800
+ ],
1801
+ "docs": "Gets a new Uint8Array view of the ArrayBuffer store for this array, referencing the elements\r\nat begin, inclusive, up to end, exclusive.",
1802
+ "complexTypes": [
1803
+ "Uint8Array"
1804
+ ],
1805
+ "slug": "subarray"
1806
+ },
1807
+ {
1808
+ "name": "toLocaleString",
1809
+ "signature": "() => string",
1810
+ "parameters": [],
1811
+ "returns": "string",
1812
+ "tags": [],
1813
+ "docs": "Converts a number to a string by using the current locale.",
1814
+ "complexTypes": [],
1815
+ "slug": "tolocalestring"
1816
+ },
1817
+ {
1818
+ "name": "toString",
1819
+ "signature": "() => string",
1820
+ "parameters": [],
1821
+ "returns": "string",
1822
+ "tags": [],
1823
+ "docs": "Returns a string representation of an array.",
1824
+ "complexTypes": [],
1825
+ "slug": "tostring"
1826
+ },
1827
+ {
1828
+ "name": "valueOf",
1829
+ "signature": "() => Uint8Array",
1830
+ "parameters": [],
1831
+ "returns": "Uint8Array",
1832
+ "tags": [],
1833
+ "docs": "Returns the primitive value of the specified object.",
1834
+ "complexTypes": [
1835
+ "Uint8Array"
1836
+ ],
1837
+ "slug": "valueof"
1838
+ }
1839
+ ],
1840
+ "properties": [
1841
+ {
1842
+ "name": "BYTES_PER_ELEMENT",
1843
+ "tags": [],
1844
+ "docs": "The size in bytes of each element in the array.",
1845
+ "complexTypes": [],
1846
+ "type": "number"
1847
+ },
1848
+ {
1849
+ "name": "buffer",
1850
+ "tags": [],
1851
+ "docs": "The ArrayBuffer instance referenced by the array.",
1852
+ "complexTypes": [
1853
+ "ArrayBufferLike"
1854
+ ],
1855
+ "type": "ArrayBufferLike"
1856
+ },
1857
+ {
1858
+ "name": "byteLength",
1859
+ "tags": [],
1860
+ "docs": "The length in bytes of the array.",
1861
+ "complexTypes": [],
1862
+ "type": "number"
1863
+ },
1864
+ {
1865
+ "name": "byteOffset",
1866
+ "tags": [],
1867
+ "docs": "The offset in bytes of the array.",
1868
+ "complexTypes": [],
1869
+ "type": "number"
1870
+ },
1871
+ {
1872
+ "name": "length",
1873
+ "tags": [],
1874
+ "docs": "The length of the array.",
1875
+ "complexTypes": [],
1876
+ "type": "number"
1877
+ }
1878
+ ]
1879
+ },
1880
+ {
1881
+ "name": "ArrayLike",
1882
+ "slug": "arraylike",
1883
+ "docs": "",
1884
+ "tags": [],
1885
+ "methods": [],
1886
+ "properties": [
1887
+ {
1888
+ "name": "length",
1889
+ "tags": [],
1890
+ "docs": "",
1891
+ "complexTypes": [],
1892
+ "type": "number"
1893
+ }
1894
+ ]
1895
+ },
1896
+ {
1897
+ "name": "ArrayBufferTypes",
1898
+ "slug": "arraybuffertypes",
1899
+ "docs": "Allowed ArrayBuffer types for the buffer of an ArrayBufferView and related Typed Arrays.",
1900
+ "tags": [],
1901
+ "methods": [],
1902
+ "properties": [
1903
+ {
1904
+ "name": "ArrayBuffer",
1905
+ "tags": [],
1906
+ "docs": "",
1907
+ "complexTypes": [
1908
+ "ArrayBuffer"
1909
+ ],
1910
+ "type": "ArrayBuffer"
1911
+ }
1912
+ ]
1913
+ },
1914
+ {
1915
+ "name": "ArrayBuffer",
1916
+ "slug": "arraybuffer",
1917
+ "docs": "Represents a raw buffer of binary data, which is used to store data for the\r\ndifferent typed arrays. ArrayBuffers cannot be read from or written to directly,\r\nbut can be passed to a typed array or DataView Object to interpret the raw\r\nbuffer as needed.",
1918
+ "tags": [],
1919
+ "methods": [
1920
+ {
1921
+ "name": "slice",
1922
+ "signature": "(begin: number, end?: number | undefined) => ArrayBuffer",
1923
+ "parameters": [
1924
+ {
1925
+ "name": "begin",
1926
+ "docs": "",
1927
+ "type": "number"
1928
+ },
1929
+ {
1930
+ "name": "end",
1931
+ "docs": "",
1932
+ "type": "number | undefined"
1933
+ }
1934
+ ],
1935
+ "returns": "ArrayBuffer",
1936
+ "tags": [],
1937
+ "docs": "Returns a section of an ArrayBuffer.",
1938
+ "complexTypes": [
1939
+ "ArrayBuffer"
1940
+ ],
1941
+ "slug": "slice"
1942
+ }
1943
+ ],
1944
+ "properties": [
1945
+ {
1946
+ "name": "byteLength",
1947
+ "tags": [],
1948
+ "docs": "Read-only. The length of the ArrayBuffer (in bytes).",
1949
+ "complexTypes": [],
1950
+ "type": "number"
1111
1951
  }
1112
1952
  ]
1113
1953
  },
@@ -1121,7 +1961,7 @@
1121
1961
  {
1122
1962
  "name": "device",
1123
1963
  "tags": [],
1124
- "docs": "The peripheral device that was found in the scan.\n**Android** and **web**: `device.name` is always identical to `localName`.\n**iOS**: `device.name` is identical to `localName` the first time a device is discovered, but after connecting `device.name` is the cached GAP name in subsequent scans.",
1964
+ "docs": "The peripheral device that was found in the scan.\r\n**Android** and **web**: `device.name` is always identical to `localName`.\r\n**iOS**: `device.name` is identical to `localName` the first time a device is discovered, but after connecting `device.name` is the cached GAP name in subsequent scans.",
1125
1965
  "complexTypes": [
1126
1966
  "BleDevice"
1127
1967
  ],
@@ -1709,46 +2549,6 @@
1709
2549
  }
1710
2550
  ]
1711
2551
  },
1712
- {
1713
- "name": "ArrayBuffer",
1714
- "slug": "arraybuffer",
1715
- "docs": "Represents a raw buffer of binary data, which is used to store data for the\r\ndifferent typed arrays. ArrayBuffers cannot be read from or written to directly,\r\nbut can be passed to a typed array or DataView Object to interpret the raw\r\nbuffer as needed.",
1716
- "tags": [],
1717
- "methods": [
1718
- {
1719
- "name": "slice",
1720
- "signature": "(begin: number, end?: number | undefined) => ArrayBuffer",
1721
- "parameters": [
1722
- {
1723
- "name": "begin",
1724
- "docs": "",
1725
- "type": "number"
1726
- },
1727
- {
1728
- "name": "end",
1729
- "docs": "",
1730
- "type": "number | undefined"
1731
- }
1732
- ],
1733
- "returns": "ArrayBuffer",
1734
- "tags": [],
1735
- "docs": "Returns a section of an ArrayBuffer.",
1736
- "complexTypes": [
1737
- "ArrayBuffer"
1738
- ],
1739
- "slug": "slice"
1740
- }
1741
- ],
1742
- "properties": [
1743
- {
1744
- "name": "byteLength",
1745
- "tags": [],
1746
- "docs": "Read-only. The length of the ArrayBuffer (in bytes).",
1747
- "complexTypes": [],
1748
- "type": "number"
1749
- }
1750
- ]
1751
- },
1752
2552
  {
1753
2553
  "name": "TimeoutOptions",
1754
2554
  "slug": "timeoutoptions",
@@ -1759,7 +2559,7 @@
1759
2559
  {
1760
2560
  "name": "timeout",
1761
2561
  "tags": [],
1762
- "docs": "Timeout in milliseconds for plugin call.\nDefault is 10000 for `connect` and 5000 for other plugin methods.",
2562
+ "docs": "Timeout in milliseconds for plugin call.\r\nDefault is 10000 for `connect` and 5000 for other plugin methods.",
1763
2563
  "complexTypes": [],
1764
2564
  "type": "number | undefined"
1765
2565
  }
@@ -1943,19 +2743,19 @@
1943
2743
  "name": "SCAN_MODE_LOW_POWER",
1944
2744
  "value": "0",
1945
2745
  "tags": [],
1946
- "docs": "Perform Bluetooth LE scan in low power mode. This mode is enforced if the scanning application is not in foreground.\nhttps://developer.android.com/reference/android/bluetooth/le/ScanSettings#SCAN_MODE_LOW_POWER"
2746
+ "docs": "Perform Bluetooth LE scan in low power mode. This mode is enforced if the scanning application is not in foreground.\r\nhttps://developer.android.com/reference/android/bluetooth/le/ScanSettings#SCAN_MODE_LOW_POWER"
1947
2747
  },
1948
2748
  {
1949
2749
  "name": "SCAN_MODE_BALANCED",
1950
2750
  "value": "1",
1951
2751
  "tags": [],
1952
- "docs": "Perform Bluetooth LE scan in balanced power mode. (default) Scan results are returned at a rate that provides a good trade-off between scan frequency and power consumption.\nhttps://developer.android.com/reference/android/bluetooth/le/ScanSettings#SCAN_MODE_BALANCED"
2752
+ "docs": "Perform Bluetooth LE scan in balanced power mode. (default) Scan results are returned at a rate that provides a good trade-off between scan frequency and power consumption.\r\nhttps://developer.android.com/reference/android/bluetooth/le/ScanSettings#SCAN_MODE_BALANCED"
1953
2753
  },
1954
2754
  {
1955
2755
  "name": "SCAN_MODE_LOW_LATENCY",
1956
2756
  "value": "2",
1957
2757
  "tags": [],
1958
- "docs": "Scan using highest duty cycle. It's recommended to only use this mode when the application is running in the foreground.\nhttps://developer.android.com/reference/android/bluetooth/le/ScanSettings#SCAN_MODE_LOW_LATENCY"
2758
+ "docs": "Scan using highest duty cycle. It's recommended to only use this mode when the application is running in the foreground.\r\nhttps://developer.android.com/reference/android/bluetooth/le/ScanSettings#SCAN_MODE_LOW_LATENCY"
1959
2759
  }
1960
2760
  ]
1961
2761
  },
@@ -1967,24 +2767,38 @@
1967
2767
  "name": "CONNECTION_PRIORITY_BALANCED",
1968
2768
  "value": "0",
1969
2769
  "tags": [],
1970
- "docs": "Use the connection parameters recommended by the Bluetooth SIG. This is the default value if no connection parameter update is requested.\nhttps://developer.android.com/reference/android/bluetooth/BluetoothGatt#CONNECTION_PRIORITY_BALANCED"
2770
+ "docs": "Use the connection parameters recommended by the Bluetooth SIG. This is the default value if no connection parameter update is requested.\r\nhttps://developer.android.com/reference/android/bluetooth/BluetoothGatt#CONNECTION_PRIORITY_BALANCED"
1971
2771
  },
1972
2772
  {
1973
2773
  "name": "CONNECTION_PRIORITY_HIGH",
1974
2774
  "value": "1",
1975
2775
  "tags": [],
1976
- "docs": "Request a high priority, low latency connection. An application should only request high priority connection parameters to transfer large amounts of data over LE quickly. Once the transfer is complete, the application should request CONNECTION_PRIORITY_BALANCED connection parameters to reduce energy use.\nhttps://developer.android.com/reference/android/bluetooth/BluetoothGatt#CONNECTION_PRIORITY_HIGH"
2776
+ "docs": "Request a high priority, low latency connection. An application should only request high priority connection parameters to transfer large amounts of data over LE quickly. Once the transfer is complete, the application should request CONNECTION_PRIORITY_BALANCED connection parameters to reduce energy use.\r\nhttps://developer.android.com/reference/android/bluetooth/BluetoothGatt#CONNECTION_PRIORITY_HIGH"
1977
2777
  },
1978
2778
  {
1979
2779
  "name": "CONNECTION_PRIORITY_LOW_POWER",
1980
2780
  "value": "2",
1981
2781
  "tags": [],
1982
- "docs": "Request low power, reduced data rate connection parameters.\nhttps://developer.android.com/reference/android/bluetooth/BluetoothGatt#CONNECTION_PRIORITY_LOW_POWER"
2782
+ "docs": "Request low power, reduced data rate connection parameters.\r\nhttps://developer.android.com/reference/android/bluetooth/BluetoothGatt#CONNECTION_PRIORITY_LOW_POWER"
2783
+ }
2784
+ ]
2785
+ }
2786
+ ],
2787
+ "typeAliases": [
2788
+ {
2789
+ "name": "ArrayBufferLike",
2790
+ "slug": "arraybufferlike",
2791
+ "docs": "",
2792
+ "types": [
2793
+ {
2794
+ "text": "ArrayBufferTypes[keyof ArrayBufferTypes]",
2795
+ "complexTypes": [
2796
+ "ArrayBufferTypes"
2797
+ ]
1983
2798
  }
1984
2799
  ]
1985
2800
  }
1986
2801
  ],
1987
- "typeAliases": [],
1988
2802
  "pluginConfigs": [
1989
2803
  {
1990
2804
  "name": "BluetoothLe",
@@ -1998,11 +2812,11 @@
1998
2812
  "name": "since"
1999
2813
  },
2000
2814
  {
2001
- "text": "{\n\"scanning\": \"Scanning...\",\n\"cancel\": \"Cancel\",\n\"availableDevices\": \"Available devices\",\n\"noDeviceFound\": \"No device found\"\n}",
2815
+ "text": "{\r\n\"scanning\": \"Scanning...\",\r\n\"cancel\": \"Cancel\",\r\n\"availableDevices\": \"Available devices\",\r\n\"noDeviceFound\": \"No device found\"\r\n}",
2002
2816
  "name": "default"
2003
2817
  },
2004
2818
  {
2005
- "text": "{\nscanning: \"Am Scannen...\",\ncancel: \"Abbrechen\",\navailableDevices: \"Verfügbare Geräte\",\nnoDeviceFound: \"Kein Gerät gefunden\",\n}",
2819
+ "text": "{\r\nscanning: \"Am Scannen...\",\r\ncancel: \"Abbrechen\",\r\navailableDevices: \"Verfügbare Geräte\",\r\nnoDeviceFound: \"Kein Gerät gefunden\",\r\n}",
2006
2820
  "name": "example"
2007
2821
  }
2008
2822
  ],