@capacitor-community/bluetooth-le 7.2.0 → 7.3.1

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.
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
  },
@@ -878,7 +878,7 @@
878
878
  "text": "options Options for plugin call. Timeout not supported on **web**."
879
879
  }
880
880
  ],
881
- "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).",
881
+ "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).",
882
882
  "complexTypes": [
883
883
  "DataView",
884
884
  "TimeoutOptions"
@@ -943,7 +943,7 @@
943
943
  "name": "default"
944
944
  }
945
945
  ],
946
- "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",
946
+ "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",
947
947
  "complexTypes": [],
948
948
  "type": "boolean | undefined"
949
949
  }
@@ -1048,7 +1048,7 @@
1048
1048
  {
1049
1049
  "name": "deviceId",
1050
1050
  "tags": [],
1051
- "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.",
1051
+ "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.",
1052
1052
  "complexTypes": [],
1053
1053
  "type": "string"
1054
1054
  },
@@ -1078,7 +1078,7 @@
1078
1078
  {
1079
1079
  "name": "services",
1080
1080
  "tags": [],
1081
- "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))",
1081
+ "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))",
1082
1082
  "complexTypes": [],
1083
1083
  "type": "string[] | undefined"
1084
1084
  },
@@ -1099,14 +1099,14 @@
1099
1099
  {
1100
1100
  "name": "optionalServices",
1101
1101
  "tags": [],
1102
- "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))",
1102
+ "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))",
1103
1103
  "complexTypes": [],
1104
1104
  "type": "string[] | undefined"
1105
1105
  },
1106
1106
  {
1107
1107
  "name": "allowDuplicates",
1108
1108
  "tags": [],
1109
- "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)",
1109
+ "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)",
1110
1110
  "complexTypes": [],
1111
1111
  "type": "boolean | undefined"
1112
1112
  },
@@ -1122,11 +1122,32 @@
1122
1122
  {
1123
1123
  "name": "manufacturerData",
1124
1124
  "tags": [],
1125
- "docs": "Allow scanning for devices with a specific manufacturer data\nhttps://developer.mozilla.org/en-US/docs/Web/API/Bluetooth/requestDevice#manufacturerdata",
1125
+ "docs": "Allow scanning for devices with a specific manufacturer data\r\nhttps://developer.mozilla.org/en-US/docs/Web/API/Bluetooth/requestDevice#manufacturerdata",
1126
1126
  "complexTypes": [
1127
1127
  "ManufacturerDataFilter"
1128
1128
  ],
1129
1129
  "type": "ManufacturerDataFilter[] | undefined"
1130
+ },
1131
+ {
1132
+ "name": "displayMode",
1133
+ "tags": [
1134
+ {
1135
+ "text": "\"alert\"",
1136
+ "name": "default"
1137
+ }
1138
+ ],
1139
+ "docs": "Display mode for the device list in `requestDevice` (**iOS** only).\r\n- `\"alert\"`: Classic alert dialog (default)\r\n- `\"list\"`: Scrollable list view",
1140
+ "complexTypes": [],
1141
+ "type": "'alert' | 'list' | undefined"
1142
+ },
1143
+ {
1144
+ "name": "serviceData",
1145
+ "tags": [],
1146
+ "docs": "Allow scanning for devices with specific service data.\r\nService data is data associated with a specific service UUID in the advertisement packet.\r\nUseful for protocols like OpenDroneID, EddyStone, and Open Beacon.",
1147
+ "complexTypes": [
1148
+ "ServiceDataFilter"
1149
+ ],
1150
+ "type": "ServiceDataFilter[] | undefined"
1130
1151
  }
1131
1152
  ]
1132
1153
  },
@@ -1147,629 +1168,642 @@
1147
1168
  {
1148
1169
  "name": "dataPrefix",
1149
1170
  "tags": [],
1150
- "docs": "Prefix to match in the manufacturer data field.\nOn **Android** this field is mandatory.",
1171
+ "docs": "Prefix to match in the manufacturer data field.\r\nOn **Android** this field is mandatory.\r\nandroid, ios: DataView\r\nweb: Uint8Array",
1151
1172
  "complexTypes": [
1173
+ "DataView",
1152
1174
  "Uint8Array"
1153
1175
  ],
1154
- "type": "Uint8Array"
1176
+ "type": "DataView | Uint8Array | undefined"
1155
1177
  },
1156
1178
  {
1157
1179
  "name": "mask",
1158
1180
  "tags": [],
1159
- "docs": "Set filter on partial manufacture data. For any bit in the mask, set it the 1 if it needs to match the one in manufacturer data, otherwise set it to 0.\nThe `mask` must have the same length of dataPrefix.",
1181
+ "docs": "Set filter on partial manufacture data. For any bit in the mask, set it the 1 if it needs to match the one in manufacturer data, otherwise set it to 0.\r\nThe `mask` must have the same length of dataPrefix.\r\nandroid, ios: DataView\r\nweb: Uint8Array",
1160
1182
  "complexTypes": [
1183
+ "DataView",
1161
1184
  "Uint8Array"
1162
1185
  ],
1163
- "type": "Uint8Array"
1186
+ "type": "DataView | Uint8Array | undefined"
1164
1187
  }
1165
1188
  ]
1166
1189
  },
1167
1190
  {
1168
- "name": "Uint8Array",
1169
- "slug": "uint8array",
1170
- "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.",
1191
+ "name": "DataView",
1192
+ "slug": "dataview",
1193
+ "docs": "",
1171
1194
  "tags": [],
1172
1195
  "methods": [
1173
1196
  {
1174
- "name": "copyWithin",
1175
- "signature": "(target: number, start: number, end?: number | undefined) => this",
1197
+ "name": "getFloat32",
1198
+ "signature": "(byteOffset: number, littleEndian?: boolean | undefined) => number",
1176
1199
  "parameters": [
1177
1200
  {
1178
- "name": "target",
1179
- "docs": "If target is negative, it is treated as length+target where length is the\r\nlength of the array.",
1180
- "type": "number"
1181
- },
1182
- {
1183
- "name": "start",
1184
- "docs": "If start is negative, it is treated as length+start. If end is negative, it\r\nis treated as length+end.",
1201
+ "name": "byteOffset",
1202
+ "docs": "The place in the buffer at which the value should be retrieved.",
1185
1203
  "type": "number"
1186
1204
  },
1187
1205
  {
1188
- "name": "end",
1189
- "docs": "If not specified, length of the this object is used as its default value.",
1190
- "type": "number | undefined"
1206
+ "name": "littleEndian",
1207
+ "docs": "",
1208
+ "type": "boolean | undefined"
1191
1209
  }
1192
1210
  ],
1193
- "returns": "this",
1211
+ "returns": "number",
1194
1212
  "tags": [
1195
1213
  {
1196
1214
  "name": "param",
1197
- "text": "target If target is negative, it is treated as length+target where length is the\r\nlength of the array."
1198
- },
1199
- {
1200
- "name": "param",
1201
- "text": "start If start is negative, it is treated as length+start. If end is negative, it\r\nis treated as length+end."
1202
- },
1203
- {
1204
- "name": "param",
1205
- "text": "end If not specified, length of the this object is used as its default value."
1215
+ "text": "byteOffset The place in the buffer at which the value should be retrieved."
1206
1216
  }
1207
1217
  ],
1208
- "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",
1218
+ "docs": "Gets the Float32 value at the specified byte offset from the start of the view. There is\r\nno alignment constraint; multi-byte values may be fetched from any offset.",
1209
1219
  "complexTypes": [],
1210
- "slug": "copywithin"
1220
+ "slug": "getfloat32"
1211
1221
  },
1212
1222
  {
1213
- "name": "every",
1214
- "signature": "(predicate: (value: number, index: number, array: Uint8Array) => unknown, thisArg?: any) => boolean",
1223
+ "name": "getFloat64",
1224
+ "signature": "(byteOffset: number, littleEndian?: boolean | undefined) => number",
1215
1225
  "parameters": [
1216
1226
  {
1217
- "name": "predicate",
1218
- "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.",
1219
- "type": "(value: number, index: number, array: Uint8Array) => unknown"
1227
+ "name": "byteOffset",
1228
+ "docs": "The place in the buffer at which the value should be retrieved.",
1229
+ "type": "number"
1220
1230
  },
1221
1231
  {
1222
- "name": "thisArg",
1223
- "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.",
1224
- "type": "any"
1232
+ "name": "littleEndian",
1233
+ "docs": "",
1234
+ "type": "boolean | undefined"
1225
1235
  }
1226
1236
  ],
1227
- "returns": "boolean",
1237
+ "returns": "number",
1228
1238
  "tags": [
1229
1239
  {
1230
1240
  "name": "param",
1231
- "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."
1232
- },
1233
- {
1234
- "name": "param",
1235
- "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."
1241
+ "text": "byteOffset The place in the buffer at which the value should be retrieved."
1236
1242
  }
1237
1243
  ],
1238
- "docs": "Determines whether all the members of an array satisfy the specified test.",
1239
- "complexTypes": [
1240
- "Uint8Array"
1241
- ],
1242
- "slug": "every"
1244
+ "docs": "Gets the Float64 value at the specified byte offset from the start of the view. There is\r\nno alignment constraint; multi-byte values may be fetched from any offset.",
1245
+ "complexTypes": [],
1246
+ "slug": "getfloat64"
1243
1247
  },
1244
1248
  {
1245
- "name": "fill",
1246
- "signature": "(value: number, start?: number | undefined, end?: number | undefined) => this",
1249
+ "name": "getInt8",
1250
+ "signature": "(byteOffset: number) => number",
1247
1251
  "parameters": [
1248
1252
  {
1249
- "name": "value",
1250
- "docs": "value to fill array section with",
1253
+ "name": "byteOffset",
1254
+ "docs": "The place in the buffer at which the value should be retrieved.",
1251
1255
  "type": "number"
1252
- },
1253
- {
1254
- "name": "start",
1255
- "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.",
1256
- "type": "number | undefined"
1257
- },
1258
- {
1259
- "name": "end",
1260
- "docs": "index to stop filling the array at. If end is negative, it is treated as\r\nlength+end.",
1261
- "type": "number | undefined"
1262
1256
  }
1263
1257
  ],
1264
- "returns": "this",
1258
+ "returns": "number",
1265
1259
  "tags": [
1266
1260
  {
1267
1261
  "name": "param",
1268
- "text": "value value to fill array section with"
1269
- },
1270
- {
1271
- "name": "param",
1272
- "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."
1273
- },
1274
- {
1275
- "name": "param",
1276
- "text": "end index to stop filling the array at. If end is negative, it is treated as\r\nlength+end."
1262
+ "text": "byteOffset The place in the buffer at which the value should be retrieved."
1277
1263
  }
1278
1264
  ],
1279
- "docs": "Returns the this object after filling the section identified by start and end with value",
1265
+ "docs": "Gets the Int8 value at the specified byte offset from the start of the view. There is\r\nno alignment constraint; multi-byte values may be fetched from any offset.",
1280
1266
  "complexTypes": [],
1281
- "slug": "fill"
1267
+ "slug": "getint8"
1282
1268
  },
1283
1269
  {
1284
- "name": "filter",
1285
- "signature": "(predicate: (value: number, index: number, array: Uint8Array) => any, thisArg?: any) => Uint8Array",
1270
+ "name": "getInt16",
1271
+ "signature": "(byteOffset: number, littleEndian?: boolean | undefined) => number",
1286
1272
  "parameters": [
1287
1273
  {
1288
- "name": "predicate",
1289
- "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.",
1290
- "type": "(value: number, index: number, array: Uint8Array) => any"
1274
+ "name": "byteOffset",
1275
+ "docs": "The place in the buffer at which the value should be retrieved.",
1276
+ "type": "number"
1291
1277
  },
1292
1278
  {
1293
- "name": "thisArg",
1294
- "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.",
1295
- "type": "any"
1279
+ "name": "littleEndian",
1280
+ "docs": "",
1281
+ "type": "boolean | undefined"
1296
1282
  }
1297
1283
  ],
1298
- "returns": "Uint8Array",
1284
+ "returns": "number",
1299
1285
  "tags": [
1300
1286
  {
1301
1287
  "name": "param",
1302
- "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."
1303
- },
1304
- {
1305
- "name": "param",
1306
- "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."
1288
+ "text": "byteOffset The place in the buffer at which the value should be retrieved."
1307
1289
  }
1308
1290
  ],
1309
- "docs": "Returns the elements of an array that meet the condition specified in a callback function.",
1310
- "complexTypes": [
1311
- "Uint8Array"
1312
- ],
1313
- "slug": "filter"
1291
+ "docs": "Gets the Int16 value at the specified byte offset from the start of the view. There is\r\nno alignment constraint; multi-byte values may be fetched from any offset.",
1292
+ "complexTypes": [],
1293
+ "slug": "getint16"
1314
1294
  },
1315
1295
  {
1316
- "name": "find",
1317
- "signature": "(predicate: (value: number, index: number, obj: Uint8Array) => boolean, thisArg?: any) => number | undefined",
1296
+ "name": "getInt32",
1297
+ "signature": "(byteOffset: number, littleEndian?: boolean | undefined) => number",
1318
1298
  "parameters": [
1319
1299
  {
1320
- "name": "predicate",
1321
- "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.",
1322
- "type": "(value: number, index: number, obj: Uint8Array) => boolean"
1300
+ "name": "byteOffset",
1301
+ "docs": "The place in the buffer at which the value should be retrieved.",
1302
+ "type": "number"
1323
1303
  },
1324
1304
  {
1325
- "name": "thisArg",
1326
- "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.",
1327
- "type": "any"
1305
+ "name": "littleEndian",
1306
+ "docs": "",
1307
+ "type": "boolean | undefined"
1328
1308
  }
1329
1309
  ],
1330
- "returns": "number | undefined",
1310
+ "returns": "number",
1331
1311
  "tags": [
1332
1312
  {
1333
1313
  "name": "param",
1334
- "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."
1335
- },
1336
- {
1337
- "name": "param",
1338
- "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."
1314
+ "text": "byteOffset The place in the buffer at which the value should be retrieved."
1339
1315
  }
1340
1316
  ],
1341
- "docs": "Returns the value of the first element in the array where predicate is true, and undefined\r\notherwise.",
1342
- "complexTypes": [
1343
- "Uint8Array"
1344
- ],
1345
- "slug": "find"
1317
+ "docs": "Gets the Int32 value at the specified byte offset from the start of the view. There is\r\nno alignment constraint; multi-byte values may be fetched from any offset.",
1318
+ "complexTypes": [],
1319
+ "slug": "getint32"
1346
1320
  },
1347
1321
  {
1348
- "name": "findIndex",
1349
- "signature": "(predicate: (value: number, index: number, obj: Uint8Array) => boolean, thisArg?: any) => number",
1322
+ "name": "getUint8",
1323
+ "signature": "(byteOffset: number) => number",
1350
1324
  "parameters": [
1351
1325
  {
1352
- "name": "predicate",
1353
- "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.",
1354
- "type": "(value: number, index: number, obj: Uint8Array) => boolean"
1355
- },
1356
- {
1357
- "name": "thisArg",
1358
- "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.",
1359
- "type": "any"
1326
+ "name": "byteOffset",
1327
+ "docs": "The place in the buffer at which the value should be retrieved.",
1328
+ "type": "number"
1360
1329
  }
1361
1330
  ],
1362
1331
  "returns": "number",
1363
1332
  "tags": [
1364
1333
  {
1365
1334
  "name": "param",
1366
- "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."
1367
- },
1368
- {
1369
- "name": "param",
1370
- "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."
1335
+ "text": "byteOffset The place in the buffer at which the value should be retrieved."
1371
1336
  }
1372
1337
  ],
1373
- "docs": "Returns the index of the first element in the array where predicate is true, and -1\r\notherwise.",
1374
- "complexTypes": [
1375
- "Uint8Array"
1376
- ],
1377
- "slug": "findindex"
1338
+ "docs": "Gets the Uint8 value at the specified byte offset from the start of the view. There is\r\nno alignment constraint; multi-byte values may be fetched from any offset.",
1339
+ "complexTypes": [],
1340
+ "slug": "getuint8"
1378
1341
  },
1379
1342
  {
1380
- "name": "forEach",
1381
- "signature": "(callbackfn: (value: number, index: number, array: Uint8Array) => void, thisArg?: any) => void",
1343
+ "name": "getUint16",
1344
+ "signature": "(byteOffset: number, littleEndian?: boolean | undefined) => number",
1382
1345
  "parameters": [
1383
1346
  {
1384
- "name": "callbackfn",
1385
- "docs": "A function that accepts up to three arguments. forEach calls the\r\ncallbackfn function one time for each element in the array.",
1386
- "type": "(value: number, index: number, array: Uint8Array) => void"
1347
+ "name": "byteOffset",
1348
+ "docs": "The place in the buffer at which the value should be retrieved.",
1349
+ "type": "number"
1387
1350
  },
1388
1351
  {
1389
- "name": "thisArg",
1390
- "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.",
1391
- "type": "any"
1352
+ "name": "littleEndian",
1353
+ "docs": "",
1354
+ "type": "boolean | undefined"
1392
1355
  }
1393
1356
  ],
1394
- "returns": "void",
1357
+ "returns": "number",
1395
1358
  "tags": [
1396
1359
  {
1397
1360
  "name": "param",
1398
- "text": "callbackfn A function that accepts up to three arguments. forEach calls the\r\ncallbackfn function one time for each element in the array."
1399
- },
1400
- {
1401
- "name": "param",
1402
- "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."
1361
+ "text": "byteOffset The place in the buffer at which the value should be retrieved."
1403
1362
  }
1404
1363
  ],
1405
- "docs": "Performs the specified action for each element in an array.",
1406
- "complexTypes": [
1407
- "Uint8Array"
1408
- ],
1409
- "slug": "foreach"
1364
+ "docs": "Gets the Uint16 value at the specified byte offset from the start of the view. There is\r\nno alignment constraint; multi-byte values may be fetched from any offset.",
1365
+ "complexTypes": [],
1366
+ "slug": "getuint16"
1410
1367
  },
1411
1368
  {
1412
- "name": "indexOf",
1413
- "signature": "(searchElement: number, fromIndex?: number | undefined) => number",
1369
+ "name": "getUint32",
1370
+ "signature": "(byteOffset: number, littleEndian?: boolean | undefined) => number",
1414
1371
  "parameters": [
1415
1372
  {
1416
- "name": "searchElement",
1417
- "docs": "The value to locate in the array.",
1373
+ "name": "byteOffset",
1374
+ "docs": "The place in the buffer at which the value should be retrieved.",
1418
1375
  "type": "number"
1419
1376
  },
1420
1377
  {
1421
- "name": "fromIndex",
1422
- "docs": "The array index at which to begin the search. If fromIndex is omitted, the\r\nsearch starts at index 0.",
1423
- "type": "number | undefined"
1378
+ "name": "littleEndian",
1379
+ "docs": "",
1380
+ "type": "boolean | undefined"
1424
1381
  }
1425
1382
  ],
1426
1383
  "returns": "number",
1427
1384
  "tags": [
1428
1385
  {
1429
1386
  "name": "param",
1430
- "text": "searchElement The value to locate in the array."
1431
- },
1432
- {
1433
- "name": "param",
1434
- "text": "fromIndex The array index at which to begin the search. If fromIndex is omitted, the\r\nsearch starts at index 0."
1387
+ "text": "byteOffset The place in the buffer at which the value should be retrieved."
1435
1388
  }
1436
1389
  ],
1437
- "docs": "Returns the index of the first occurrence of a value in an array.",
1390
+ "docs": "Gets the Uint32 value at the specified byte offset from the start of the view. There is\r\nno alignment constraint; multi-byte values may be fetched from any offset.",
1438
1391
  "complexTypes": [],
1439
- "slug": "indexof"
1392
+ "slug": "getuint32"
1440
1393
  },
1441
1394
  {
1442
- "name": "join",
1443
- "signature": "(separator?: string | undefined) => string",
1395
+ "name": "setFloat32",
1396
+ "signature": "(byteOffset: number, value: number, littleEndian?: boolean | undefined) => void",
1444
1397
  "parameters": [
1445
1398
  {
1446
- "name": "separator",
1447
- "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.",
1448
- "type": "string | undefined"
1399
+ "name": "byteOffset",
1400
+ "docs": "The place in the buffer at which the value should be set.",
1401
+ "type": "number"
1402
+ },
1403
+ {
1404
+ "name": "value",
1405
+ "docs": "The value to set.",
1406
+ "type": "number"
1407
+ },
1408
+ {
1409
+ "name": "littleEndian",
1410
+ "docs": "If false or undefined, a big-endian value should be written,\r\notherwise a little-endian value should be written.",
1411
+ "type": "boolean | undefined"
1449
1412
  }
1450
1413
  ],
1451
- "returns": "string",
1414
+ "returns": "void",
1452
1415
  "tags": [
1453
1416
  {
1454
1417
  "name": "param",
1455
- "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."
1418
+ "text": "byteOffset The place in the buffer at which the value should be set."
1419
+ },
1420
+ {
1421
+ "name": "param",
1422
+ "text": "value The value to set."
1423
+ },
1424
+ {
1425
+ "name": "param",
1426
+ "text": "littleEndian If false or undefined, a big-endian value should be written,\r\notherwise a little-endian value should be written."
1456
1427
  }
1457
1428
  ],
1458
- "docs": "Adds all the elements of an array separated by the specified separator string.",
1429
+ "docs": "Stores an Float32 value at the specified byte offset from the start of the view.",
1459
1430
  "complexTypes": [],
1460
- "slug": "join"
1431
+ "slug": "setfloat32"
1461
1432
  },
1462
1433
  {
1463
- "name": "lastIndexOf",
1464
- "signature": "(searchElement: number, fromIndex?: number | undefined) => number",
1434
+ "name": "setFloat64",
1435
+ "signature": "(byteOffset: number, value: number, littleEndian?: boolean | undefined) => void",
1465
1436
  "parameters": [
1466
1437
  {
1467
- "name": "searchElement",
1468
- "docs": "The value to locate in the array.",
1438
+ "name": "byteOffset",
1439
+ "docs": "The place in the buffer at which the value should be set.",
1469
1440
  "type": "number"
1470
1441
  },
1471
1442
  {
1472
- "name": "fromIndex",
1473
- "docs": "The array index at which to begin the search. If fromIndex is omitted, the\r\nsearch starts at index 0.",
1474
- "type": "number | undefined"
1443
+ "name": "value",
1444
+ "docs": "The value to set.",
1445
+ "type": "number"
1446
+ },
1447
+ {
1448
+ "name": "littleEndian",
1449
+ "docs": "If false or undefined, a big-endian value should be written,\r\notherwise a little-endian value should be written.",
1450
+ "type": "boolean | undefined"
1475
1451
  }
1476
1452
  ],
1477
- "returns": "number",
1453
+ "returns": "void",
1478
1454
  "tags": [
1479
1455
  {
1480
1456
  "name": "param",
1481
- "text": "searchElement The value to locate in the array."
1457
+ "text": "byteOffset The place in the buffer at which the value should be set."
1482
1458
  },
1483
1459
  {
1484
1460
  "name": "param",
1485
- "text": "fromIndex The array index at which to begin the search. If fromIndex is omitted, the\r\nsearch starts at index 0."
1461
+ "text": "value The value to set."
1462
+ },
1463
+ {
1464
+ "name": "param",
1465
+ "text": "littleEndian If false or undefined, a big-endian value should be written,\r\notherwise a little-endian value should be written."
1486
1466
  }
1487
1467
  ],
1488
- "docs": "Returns the index of the last occurrence of a value in an array.",
1468
+ "docs": "Stores an Float64 value at the specified byte offset from the start of the view.",
1489
1469
  "complexTypes": [],
1490
- "slug": "lastindexof"
1470
+ "slug": "setfloat64"
1491
1471
  },
1492
1472
  {
1493
- "name": "map",
1494
- "signature": "(callbackfn: (value: number, index: number, array: Uint8Array) => number, thisArg?: any) => Uint8Array",
1473
+ "name": "setInt8",
1474
+ "signature": "(byteOffset: number, value: number) => void",
1495
1475
  "parameters": [
1496
1476
  {
1497
- "name": "callbackfn",
1498
- "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.",
1499
- "type": "(value: number, index: number, array: Uint8Array) => number"
1477
+ "name": "byteOffset",
1478
+ "docs": "The place in the buffer at which the value should be set.",
1479
+ "type": "number"
1500
1480
  },
1501
1481
  {
1502
- "name": "thisArg",
1503
- "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.",
1504
- "type": "any"
1482
+ "name": "value",
1483
+ "docs": "The value to set.",
1484
+ "type": "number"
1505
1485
  }
1506
1486
  ],
1507
- "returns": "Uint8Array",
1487
+ "returns": "void",
1508
1488
  "tags": [
1509
1489
  {
1510
1490
  "name": "param",
1511
- "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."
1491
+ "text": "byteOffset The place in the buffer at which the value should be set."
1512
1492
  },
1513
1493
  {
1514
1494
  "name": "param",
1515
- "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."
1495
+ "text": "value The value to set."
1516
1496
  }
1517
1497
  ],
1518
- "docs": "Calls a defined callback function on each element of an array, and returns an array that\r\ncontains the results.",
1519
- "complexTypes": [
1520
- "Uint8Array"
1521
- ],
1522
- "slug": "map"
1498
+ "docs": "Stores an Int8 value at the specified byte offset from the start of the view.",
1499
+ "complexTypes": [],
1500
+ "slug": "setint8"
1523
1501
  },
1524
1502
  {
1525
- "name": "reduce",
1526
- "signature": "(callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: Uint8Array) => number) => number",
1503
+ "name": "setInt16",
1504
+ "signature": "(byteOffset: number, value: number, littleEndian?: boolean | undefined) => void",
1527
1505
  "parameters": [
1528
1506
  {
1529
- "name": "callbackfn",
1530
- "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.",
1531
- "type": "(previousValue: number, currentValue: number, currentIndex: number, array: Uint8Array) => number"
1507
+ "name": "byteOffset",
1508
+ "docs": "The place in the buffer at which the value should be set.",
1509
+ "type": "number"
1510
+ },
1511
+ {
1512
+ "name": "value",
1513
+ "docs": "The value to set.",
1514
+ "type": "number"
1515
+ },
1516
+ {
1517
+ "name": "littleEndian",
1518
+ "docs": "If false or undefined, a big-endian value should be written,\r\notherwise a little-endian value should be written.",
1519
+ "type": "boolean | undefined"
1532
1520
  }
1533
1521
  ],
1534
- "returns": "number",
1522
+ "returns": "void",
1535
1523
  "tags": [
1536
1524
  {
1537
1525
  "name": "param",
1538
- "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."
1526
+ "text": "byteOffset The place in the buffer at which the value should be set."
1539
1527
  },
1540
1528
  {
1541
1529
  "name": "param",
1542
- "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."
1530
+ "text": "value The value to set."
1531
+ },
1532
+ {
1533
+ "name": "param",
1534
+ "text": "littleEndian If false or undefined, a big-endian value should be written,\r\notherwise a little-endian value should be written."
1543
1535
  }
1544
1536
  ],
1545
- "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.",
1546
- "complexTypes": [
1547
- "Uint8Array"
1548
- ],
1549
- "slug": "reduce"
1537
+ "docs": "Stores an Int16 value at the specified byte offset from the start of the view.",
1538
+ "complexTypes": [],
1539
+ "slug": "setint16"
1550
1540
  },
1551
1541
  {
1552
- "name": "reduce",
1553
- "signature": "(callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: Uint8Array) => number, initialValue: number) => number",
1542
+ "name": "setInt32",
1543
+ "signature": "(byteOffset: number, value: number, littleEndian?: boolean | undefined) => void",
1554
1544
  "parameters": [
1555
1545
  {
1556
- "name": "callbackfn",
1557
- "docs": "",
1558
- "type": "(previousValue: number, currentValue: number, currentIndex: number, array: Uint8Array) => number"
1546
+ "name": "byteOffset",
1547
+ "docs": "The place in the buffer at which the value should be set.",
1548
+ "type": "number"
1559
1549
  },
1560
1550
  {
1561
- "name": "initialValue",
1562
- "docs": "",
1551
+ "name": "value",
1552
+ "docs": "The value to set.",
1563
1553
  "type": "number"
1564
- }
1565
- ],
1566
- "returns": "number",
1567
- "tags": [],
1568
- "docs": "",
1569
- "complexTypes": [
1570
- "Uint8Array"
1571
- ],
1572
- "slug": "reduce"
1573
- },
1574
- {
1575
- "name": "reduce",
1576
- "signature": "<U>(callbackfn: (previousValue: U, currentValue: number, currentIndex: number, array: Uint8Array) => U, initialValue: U) => U",
1577
- "parameters": [
1578
- {
1579
- "name": "callbackfn",
1580
- "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.",
1581
- "type": "(previousValue: U, currentValue: number, currentIndex: number, array: Uint8Array) => U"
1582
1554
  },
1583
1555
  {
1584
- "name": "initialValue",
1585
- "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.",
1586
- "type": "U"
1556
+ "name": "littleEndian",
1557
+ "docs": "If false or undefined, a big-endian value should be written,\r\notherwise a little-endian value should be written.",
1558
+ "type": "boolean | undefined"
1587
1559
  }
1588
1560
  ],
1589
- "returns": "U",
1561
+ "returns": "void",
1590
1562
  "tags": [
1591
1563
  {
1592
1564
  "name": "param",
1593
- "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."
1565
+ "text": "byteOffset The place in the buffer at which the value should be set."
1594
1566
  },
1595
1567
  {
1596
1568
  "name": "param",
1597
- "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."
1569
+ "text": "value The value to set."
1570
+ },
1571
+ {
1572
+ "name": "param",
1573
+ "text": "littleEndian If false or undefined, a big-endian value should be written,\r\notherwise a little-endian value should be written."
1598
1574
  }
1599
1575
  ],
1600
- "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.",
1601
- "complexTypes": [
1602
- "U",
1603
- "Uint8Array"
1604
- ],
1605
- "slug": "reduce"
1576
+ "docs": "Stores an Int32 value at the specified byte offset from the start of the view.",
1577
+ "complexTypes": [],
1578
+ "slug": "setint32"
1606
1579
  },
1607
1580
  {
1608
- "name": "reduceRight",
1609
- "signature": "(callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: Uint8Array) => number) => number",
1581
+ "name": "setUint8",
1582
+ "signature": "(byteOffset: number, value: number) => void",
1610
1583
  "parameters": [
1611
1584
  {
1612
- "name": "callbackfn",
1613
- "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.",
1614
- "type": "(previousValue: number, currentValue: number, currentIndex: number, array: Uint8Array) => number"
1585
+ "name": "byteOffset",
1586
+ "docs": "The place in the buffer at which the value should be set.",
1587
+ "type": "number"
1588
+ },
1589
+ {
1590
+ "name": "value",
1591
+ "docs": "The value to set.",
1592
+ "type": "number"
1615
1593
  }
1616
1594
  ],
1617
- "returns": "number",
1595
+ "returns": "void",
1618
1596
  "tags": [
1619
1597
  {
1620
1598
  "name": "param",
1621
- "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."
1599
+ "text": "byteOffset The place in the buffer at which the value should be set."
1622
1600
  },
1623
1601
  {
1624
1602
  "name": "param",
1625
- "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."
1603
+ "text": "value The value to set."
1626
1604
  }
1627
1605
  ],
1628
- "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.",
1629
- "complexTypes": [
1630
- "Uint8Array"
1631
- ],
1632
- "slug": "reduceright"
1606
+ "docs": "Stores an Uint8 value at the specified byte offset from the start of the view.",
1607
+ "complexTypes": [],
1608
+ "slug": "setuint8"
1633
1609
  },
1634
1610
  {
1635
- "name": "reduceRight",
1636
- "signature": "(callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: Uint8Array) => number, initialValue: number) => number",
1611
+ "name": "setUint16",
1612
+ "signature": "(byteOffset: number, value: number, littleEndian?: boolean | undefined) => void",
1637
1613
  "parameters": [
1638
1614
  {
1639
- "name": "callbackfn",
1640
- "docs": "",
1641
- "type": "(previousValue: number, currentValue: number, currentIndex: number, array: Uint8Array) => number"
1615
+ "name": "byteOffset",
1616
+ "docs": "The place in the buffer at which the value should be set.",
1617
+ "type": "number"
1642
1618
  },
1643
1619
  {
1644
- "name": "initialValue",
1645
- "docs": "",
1620
+ "name": "value",
1621
+ "docs": "The value to set.",
1646
1622
  "type": "number"
1623
+ },
1624
+ {
1625
+ "name": "littleEndian",
1626
+ "docs": "If false or undefined, a big-endian value should be written,\r\notherwise a little-endian value should be written.",
1627
+ "type": "boolean | undefined"
1647
1628
  }
1648
1629
  ],
1649
- "returns": "number",
1650
- "tags": [],
1651
- "docs": "",
1652
- "complexTypes": [
1653
- "Uint8Array"
1630
+ "returns": "void",
1631
+ "tags": [
1632
+ {
1633
+ "name": "param",
1634
+ "text": "byteOffset The place in the buffer at which the value should be set."
1635
+ },
1636
+ {
1637
+ "name": "param",
1638
+ "text": "value The value to set."
1639
+ },
1640
+ {
1641
+ "name": "param",
1642
+ "text": "littleEndian If false or undefined, a big-endian value should be written,\r\notherwise a little-endian value should be written."
1643
+ }
1654
1644
  ],
1655
- "slug": "reduceright"
1645
+ "docs": "Stores an Uint16 value at the specified byte offset from the start of the view.",
1646
+ "complexTypes": [],
1647
+ "slug": "setuint16"
1656
1648
  },
1657
1649
  {
1658
- "name": "reduceRight",
1659
- "signature": "<U>(callbackfn: (previousValue: U, currentValue: number, currentIndex: number, array: Uint8Array) => U, initialValue: U) => U",
1650
+ "name": "setUint32",
1651
+ "signature": "(byteOffset: number, value: number, littleEndian?: boolean | undefined) => void",
1660
1652
  "parameters": [
1661
1653
  {
1662
- "name": "callbackfn",
1663
- "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.",
1664
- "type": "(previousValue: U, currentValue: number, currentIndex: number, array: Uint8Array) => U"
1654
+ "name": "byteOffset",
1655
+ "docs": "The place in the buffer at which the value should be set.",
1656
+ "type": "number"
1665
1657
  },
1666
1658
  {
1667
- "name": "initialValue",
1668
- "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.",
1669
- "type": "U"
1659
+ "name": "value",
1660
+ "docs": "The value to set.",
1661
+ "type": "number"
1662
+ },
1663
+ {
1664
+ "name": "littleEndian",
1665
+ "docs": "If false or undefined, a big-endian value should be written,\r\notherwise a little-endian value should be written.",
1666
+ "type": "boolean | undefined"
1670
1667
  }
1671
1668
  ],
1672
- "returns": "U",
1669
+ "returns": "void",
1673
1670
  "tags": [
1674
1671
  {
1675
1672
  "name": "param",
1676
- "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."
1673
+ "text": "byteOffset The place in the buffer at which the value should be set."
1677
1674
  },
1678
1675
  {
1679
1676
  "name": "param",
1680
- "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."
1677
+ "text": "value The value to set."
1678
+ },
1679
+ {
1680
+ "name": "param",
1681
+ "text": "littleEndian If false or undefined, a big-endian value should be written,\r\notherwise a little-endian value should be written."
1681
1682
  }
1682
1683
  ],
1683
- "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.",
1684
+ "docs": "Stores an Uint32 value at the specified byte offset from the start of the view.",
1685
+ "complexTypes": [],
1686
+ "slug": "setuint32"
1687
+ }
1688
+ ],
1689
+ "properties": [
1690
+ {
1691
+ "name": "buffer",
1692
+ "tags": [],
1693
+ "docs": "",
1684
1694
  "complexTypes": [
1685
- "U",
1686
- "Uint8Array"
1695
+ "ArrayBuffer"
1687
1696
  ],
1688
- "slug": "reduceright"
1697
+ "type": "ArrayBuffer"
1689
1698
  },
1690
1699
  {
1691
- "name": "reverse",
1692
- "signature": "() => Uint8Array",
1693
- "parameters": [],
1694
- "returns": "Uint8Array",
1700
+ "name": "byteLength",
1695
1701
  "tags": [],
1696
- "docs": "Reverses the elements in an Array.",
1697
- "complexTypes": [
1698
- "Uint8Array"
1699
- ],
1700
- "slug": "reverse"
1702
+ "docs": "",
1703
+ "complexTypes": [],
1704
+ "type": "number"
1701
1705
  },
1702
1706
  {
1703
- "name": "set",
1704
- "signature": "(array: ArrayLike<number>, offset?: number | undefined) => void",
1707
+ "name": "byteOffset",
1708
+ "tags": [],
1709
+ "docs": "",
1710
+ "complexTypes": [],
1711
+ "type": "number"
1712
+ }
1713
+ ]
1714
+ },
1715
+ {
1716
+ "name": "ArrayBuffer",
1717
+ "slug": "arraybuffer",
1718
+ "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.",
1719
+ "tags": [],
1720
+ "methods": [
1721
+ {
1722
+ "name": "slice",
1723
+ "signature": "(begin: number, end?: number | undefined) => ArrayBuffer",
1705
1724
  "parameters": [
1706
1725
  {
1707
- "name": "array",
1708
- "docs": "A typed or untyped array of values to set.",
1709
- "type": "ArrayLike<number>"
1726
+ "name": "begin",
1727
+ "docs": "",
1728
+ "type": "number"
1710
1729
  },
1711
1730
  {
1712
- "name": "offset",
1713
- "docs": "The index in the current array at which the values are to be written.",
1731
+ "name": "end",
1732
+ "docs": "",
1714
1733
  "type": "number | undefined"
1715
1734
  }
1716
1735
  ],
1717
- "returns": "void",
1718
- "tags": [
1719
- {
1720
- "name": "param",
1721
- "text": "array A typed or untyped array of values to set."
1722
- },
1723
- {
1724
- "name": "param",
1725
- "text": "offset The index in the current array at which the values are to be written."
1726
- }
1727
- ],
1728
- "docs": "Sets a value or an array of values.",
1736
+ "returns": "ArrayBuffer",
1737
+ "tags": [],
1738
+ "docs": "Returns a section of an ArrayBuffer.",
1729
1739
  "complexTypes": [
1730
- "ArrayLike"
1740
+ "ArrayBuffer"
1731
1741
  ],
1732
- "slug": "set"
1733
- },
1742
+ "slug": "slice"
1743
+ }
1744
+ ],
1745
+ "properties": [
1734
1746
  {
1735
- "name": "slice",
1736
- "signature": "(start?: number | undefined, end?: number | undefined) => Uint8Array",
1747
+ "name": "byteLength",
1748
+ "tags": [],
1749
+ "docs": "Read-only. The length of the ArrayBuffer (in bytes).",
1750
+ "complexTypes": [],
1751
+ "type": "number"
1752
+ }
1753
+ ]
1754
+ },
1755
+ {
1756
+ "name": "Uint8Array",
1757
+ "slug": "uint8array",
1758
+ "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.",
1759
+ "tags": [],
1760
+ "methods": [
1761
+ {
1762
+ "name": "copyWithin",
1763
+ "signature": "(target: number, start: number, end?: number | undefined) => this",
1737
1764
  "parameters": [
1765
+ {
1766
+ "name": "target",
1767
+ "docs": "If target is negative, it is treated as length+target where length is the\r\nlength of the array.",
1768
+ "type": "number"
1769
+ },
1738
1770
  {
1739
1771
  "name": "start",
1740
- "docs": "The beginning of the specified portion of the array.",
1741
- "type": "number | undefined"
1772
+ "docs": "If start is negative, it is treated as length+start. If end is negative, it\r\nis treated as length+end.",
1773
+ "type": "number"
1742
1774
  },
1743
1775
  {
1744
1776
  "name": "end",
1745
- "docs": "The end of the specified portion of the array. This is exclusive of the element at the index 'end'.",
1777
+ "docs": "If not specified, length of the this object is used as its default value.",
1746
1778
  "type": "number | undefined"
1747
1779
  }
1748
1780
  ],
1749
- "returns": "Uint8Array",
1781
+ "returns": "this",
1750
1782
  "tags": [
1751
1783
  {
1752
1784
  "name": "param",
1753
- "text": "start The beginning of the specified portion of the array."
1785
+ "text": "target If target is negative, it is treated as length+target where length is the\r\nlength of the array."
1754
1786
  },
1755
1787
  {
1756
1788
  "name": "param",
1757
- "text": "end The end of the specified portion of the array. This is exclusive of the element at the index 'end'."
1789
+ "text": "start If start is negative, it is treated as length+start. If end is negative, it\r\nis treated as length+end."
1790
+ },
1791
+ {
1792
+ "name": "param",
1793
+ "text": "end If not specified, length of the this object is used as its default value."
1758
1794
  }
1759
1795
  ],
1760
- "docs": "Returns a section of an array.",
1761
- "complexTypes": [
1762
- "Uint8Array"
1763
- ],
1764
- "slug": "slice"
1796
+ "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",
1797
+ "complexTypes": [],
1798
+ "slug": "copywithin"
1765
1799
  },
1766
1800
  {
1767
- "name": "some",
1801
+ "name": "every",
1768
1802
  "signature": "(predicate: (value: number, index: number, array: Uint8Array) => unknown, thisArg?: any) => boolean",
1769
1803
  "parameters": [
1770
1804
  {
1771
1805
  "name": "predicate",
1772
- "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.",
1806
+ "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.",
1773
1807
  "type": "(value: number, index: number, array: Uint8Array) => unknown"
1774
1808
  },
1775
1809
  {
@@ -1782,817 +1816,840 @@
1782
1816
  "tags": [
1783
1817
  {
1784
1818
  "name": "param",
1785
- "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."
1819
+ "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."
1786
1820
  },
1787
1821
  {
1788
1822
  "name": "param",
1789
1823
  "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."
1790
1824
  }
1791
1825
  ],
1792
- "docs": "Determines whether the specified callback function returns true for any element of an array.",
1826
+ "docs": "Determines whether all the members of an array satisfy the specified test.",
1793
1827
  "complexTypes": [
1794
1828
  "Uint8Array"
1795
1829
  ],
1796
- "slug": "some"
1830
+ "slug": "every"
1797
1831
  },
1798
1832
  {
1799
- "name": "sort",
1800
- "signature": "(compareFn?: ((a: number, b: number) => number) | undefined) => this",
1833
+ "name": "fill",
1834
+ "signature": "(value: number, start?: number | undefined, end?: number | undefined) => this",
1801
1835
  "parameters": [
1802
1836
  {
1803
- "name": "compareFn",
1804
- "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```",
1805
- "type": "((a: number, b: number) => number) | undefined"
1837
+ "name": "value",
1838
+ "docs": "value to fill array section with",
1839
+ "type": "number"
1840
+ },
1841
+ {
1842
+ "name": "start",
1843
+ "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.",
1844
+ "type": "number | undefined"
1845
+ },
1846
+ {
1847
+ "name": "end",
1848
+ "docs": "index to stop filling the array at. If end is negative, it is treated as\r\nlength+end.",
1849
+ "type": "number | undefined"
1806
1850
  }
1807
1851
  ],
1808
1852
  "returns": "this",
1809
1853
  "tags": [
1810
1854
  {
1811
1855
  "name": "param",
1812
- "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```"
1856
+ "text": "value value to fill array section with"
1857
+ },
1858
+ {
1859
+ "name": "param",
1860
+ "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."
1861
+ },
1862
+ {
1863
+ "name": "param",
1864
+ "text": "end index to stop filling the array at. If end is negative, it is treated as\r\nlength+end."
1813
1865
  }
1814
1866
  ],
1815
- "docs": "Sorts an array.",
1867
+ "docs": "Returns the this object after filling the section identified by start and end with value",
1816
1868
  "complexTypes": [],
1817
- "slug": "sort"
1869
+ "slug": "fill"
1818
1870
  },
1819
1871
  {
1820
- "name": "subarray",
1821
- "signature": "(begin?: number | undefined, end?: number | undefined) => Uint8Array",
1872
+ "name": "filter",
1873
+ "signature": "(predicate: (value: number, index: number, array: Uint8Array) => any, thisArg?: any) => Uint8Array",
1822
1874
  "parameters": [
1823
1875
  {
1824
- "name": "begin",
1825
- "docs": "The index of the beginning of the array.",
1826
- "type": "number | undefined"
1876
+ "name": "predicate",
1877
+ "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.",
1878
+ "type": "(value: number, index: number, array: Uint8Array) => any"
1827
1879
  },
1828
1880
  {
1829
- "name": "end",
1830
- "docs": "The index of the end of the array.",
1831
- "type": "number | undefined"
1881
+ "name": "thisArg",
1882
+ "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.",
1883
+ "type": "any"
1832
1884
  }
1833
1885
  ],
1834
1886
  "returns": "Uint8Array",
1835
1887
  "tags": [
1836
1888
  {
1837
1889
  "name": "param",
1838
- "text": "begin The index of the beginning of the array."
1890
+ "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."
1839
1891
  },
1840
1892
  {
1841
1893
  "name": "param",
1842
- "text": "end The index of the end of the array."
1894
+ "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."
1843
1895
  }
1844
1896
  ],
1845
- "docs": "Gets a new Uint8Array view of the ArrayBuffer store for this array, referencing the elements\r\nat begin, inclusive, up to end, exclusive.",
1897
+ "docs": "Returns the elements of an array that meet the condition specified in a callback function.",
1846
1898
  "complexTypes": [
1847
1899
  "Uint8Array"
1848
1900
  ],
1849
- "slug": "subarray"
1901
+ "slug": "filter"
1850
1902
  },
1851
1903
  {
1852
- "name": "toLocaleString",
1853
- "signature": "() => string",
1854
- "parameters": [],
1855
- "returns": "string",
1856
- "tags": [],
1857
- "docs": "Converts a number to a string by using the current locale.",
1858
- "complexTypes": [],
1859
- "slug": "tolocalestring"
1860
- },
1861
- {
1862
- "name": "toString",
1863
- "signature": "() => string",
1864
- "parameters": [],
1865
- "returns": "string",
1866
- "tags": [],
1867
- "docs": "Returns a string representation of an array.",
1868
- "complexTypes": [],
1869
- "slug": "tostring"
1870
- },
1871
- {
1872
- "name": "valueOf",
1873
- "signature": "() => Uint8Array",
1874
- "parameters": [],
1875
- "returns": "Uint8Array",
1876
- "tags": [],
1877
- "docs": "Returns the primitive value of the specified object.",
1878
- "complexTypes": [
1879
- "Uint8Array"
1880
- ],
1881
- "slug": "valueof"
1882
- }
1883
- ],
1884
- "properties": [
1885
- {
1886
- "name": "BYTES_PER_ELEMENT",
1887
- "tags": [],
1888
- "docs": "The size in bytes of each element in the array.",
1889
- "complexTypes": [],
1890
- "type": "number"
1891
- },
1892
- {
1893
- "name": "buffer",
1894
- "tags": [],
1895
- "docs": "The ArrayBuffer instance referenced by the array.",
1896
- "complexTypes": [
1897
- "ArrayBufferLike"
1898
- ],
1899
- "type": "ArrayBufferLike"
1900
- },
1901
- {
1902
- "name": "byteLength",
1903
- "tags": [],
1904
- "docs": "The length in bytes of the array.",
1905
- "complexTypes": [],
1906
- "type": "number"
1907
- },
1908
- {
1909
- "name": "byteOffset",
1910
- "tags": [],
1911
- "docs": "The offset in bytes of the array.",
1912
- "complexTypes": [],
1913
- "type": "number"
1914
- },
1915
- {
1916
- "name": "length",
1917
- "tags": [],
1918
- "docs": "The length of the array.",
1919
- "complexTypes": [],
1920
- "type": "number"
1921
- }
1922
- ]
1923
- },
1924
- {
1925
- "name": "ArrayLike",
1926
- "slug": "arraylike",
1927
- "docs": "",
1928
- "tags": [],
1929
- "methods": [],
1930
- "properties": [
1931
- {
1932
- "name": "length",
1933
- "tags": [],
1934
- "docs": "",
1935
- "complexTypes": [],
1936
- "type": "number"
1937
- }
1938
- ]
1939
- },
1940
- {
1941
- "name": "ArrayBufferTypes",
1942
- "slug": "arraybuffertypes",
1943
- "docs": "Allowed ArrayBuffer types for the buffer of an ArrayBufferView and related Typed Arrays.",
1944
- "tags": [],
1945
- "methods": [],
1946
- "properties": [
1947
- {
1948
- "name": "ArrayBuffer",
1949
- "tags": [],
1950
- "docs": "",
1951
- "complexTypes": [
1952
- "ArrayBuffer"
1953
- ],
1954
- "type": "ArrayBuffer"
1955
- }
1956
- ]
1957
- },
1958
- {
1959
- "name": "ArrayBuffer",
1960
- "slug": "arraybuffer",
1961
- "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.",
1962
- "tags": [],
1963
- "methods": [
1964
- {
1965
- "name": "slice",
1966
- "signature": "(begin: number, end?: number | undefined) => ArrayBuffer",
1904
+ "name": "find",
1905
+ "signature": "(predicate: (value: number, index: number, obj: Uint8Array) => boolean, thisArg?: any) => number | undefined",
1967
1906
  "parameters": [
1968
1907
  {
1969
- "name": "begin",
1970
- "docs": "",
1971
- "type": "number"
1908
+ "name": "predicate",
1909
+ "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.",
1910
+ "type": "(value: number, index: number, obj: Uint8Array) => boolean"
1972
1911
  },
1973
1912
  {
1974
- "name": "end",
1975
- "docs": "",
1976
- "type": "number | undefined"
1913
+ "name": "thisArg",
1914
+ "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.",
1915
+ "type": "any"
1977
1916
  }
1978
1917
  ],
1979
- "returns": "ArrayBuffer",
1980
- "tags": [],
1981
- "docs": "Returns a section of an ArrayBuffer.",
1982
- "complexTypes": [
1983
- "ArrayBuffer"
1984
- ],
1985
- "slug": "slice"
1986
- }
1987
- ],
1988
- "properties": [
1989
- {
1990
- "name": "byteLength",
1991
- "tags": [],
1992
- "docs": "Read-only. The length of the ArrayBuffer (in bytes).",
1993
- "complexTypes": [],
1994
- "type": "number"
1995
- }
1996
- ]
1997
- },
1998
- {
1999
- "name": "ScanResult",
2000
- "slug": "scanresult",
2001
- "docs": "",
2002
- "tags": [],
2003
- "methods": [],
2004
- "properties": [
2005
- {
2006
- "name": "device",
2007
- "tags": [],
2008
- "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.",
2009
- "complexTypes": [
2010
- "BleDevice"
2011
- ],
2012
- "type": "BleDevice"
2013
- },
2014
- {
2015
- "name": "localName",
2016
- "tags": [],
2017
- "docs": "The name of the peripheral device from the advertisement data.",
2018
- "complexTypes": [],
2019
- "type": "string | undefined"
2020
- },
2021
- {
2022
- "name": "rssi",
2023
- "tags": [],
2024
- "docs": "Received Signal Strength Indication.",
2025
- "complexTypes": [],
2026
- "type": "number | undefined"
2027
- },
2028
- {
2029
- "name": "txPower",
2030
- "tags": [],
2031
- "docs": "Transmit power in dBm. A value of 127 indicates that it is not available.",
2032
- "complexTypes": [],
2033
- "type": "number | undefined"
2034
- },
2035
- {
2036
- "name": "manufacturerData",
2037
- "tags": [],
2038
- "docs": "Manufacturer data, key is a company identifier and value is the data.",
2039
- "complexTypes": [
2040
- "DataView"
2041
- ],
2042
- "type": "{ [key: string]: DataView; } | undefined"
2043
- },
2044
- {
2045
- "name": "serviceData",
2046
- "tags": [],
2047
- "docs": "Service data, key is a service UUID and value is the data.",
2048
- "complexTypes": [
2049
- "DataView"
2050
- ],
2051
- "type": "{ [key: string]: DataView; } | undefined"
2052
- },
2053
- {
2054
- "name": "uuids",
2055
- "tags": [],
2056
- "docs": "Advertised services.",
2057
- "complexTypes": [],
2058
- "type": "string[] | undefined"
2059
- },
2060
- {
2061
- "name": "rawAdvertisement",
2062
- "tags": [],
2063
- "docs": "Raw advertisement data (**Android** only).",
2064
- "complexTypes": [
2065
- "DataView"
2066
- ],
2067
- "type": "DataView"
2068
- }
2069
- ]
2070
- },
2071
- {
2072
- "name": "DataView",
2073
- "slug": "dataview",
2074
- "docs": "",
2075
- "tags": [],
2076
- "methods": [
2077
- {
2078
- "name": "getFloat32",
2079
- "signature": "(byteOffset: number, littleEndian?: boolean | undefined) => number",
2080
- "parameters": [
1918
+ "returns": "number | undefined",
1919
+ "tags": [
2081
1920
  {
2082
- "name": "byteOffset",
2083
- "docs": "The place in the buffer at which the value should be retrieved.",
2084
- "type": "number"
1921
+ "name": "param",
1922
+ "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."
2085
1923
  },
2086
- {
2087
- "name": "littleEndian",
2088
- "docs": "",
2089
- "type": "boolean | undefined"
2090
- }
2091
- ],
2092
- "returns": "number",
2093
- "tags": [
2094
1924
  {
2095
1925
  "name": "param",
2096
- "text": "byteOffset The place in the buffer at which the value should be retrieved."
1926
+ "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."
2097
1927
  }
2098
1928
  ],
2099
- "docs": "Gets the Float32 value at the specified byte offset from the start of the view. There is\r\nno alignment constraint; multi-byte values may be fetched from any offset.",
2100
- "complexTypes": [],
2101
- "slug": "getfloat32"
1929
+ "docs": "Returns the value of the first element in the array where predicate is true, and undefined\r\notherwise.",
1930
+ "complexTypes": [
1931
+ "Uint8Array"
1932
+ ],
1933
+ "slug": "find"
2102
1934
  },
2103
1935
  {
2104
- "name": "getFloat64",
2105
- "signature": "(byteOffset: number, littleEndian?: boolean | undefined) => number",
1936
+ "name": "findIndex",
1937
+ "signature": "(predicate: (value: number, index: number, obj: Uint8Array) => boolean, thisArg?: any) => number",
2106
1938
  "parameters": [
2107
1939
  {
2108
- "name": "byteOffset",
2109
- "docs": "The place in the buffer at which the value should be retrieved.",
2110
- "type": "number"
1940
+ "name": "predicate",
1941
+ "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.",
1942
+ "type": "(value: number, index: number, obj: Uint8Array) => boolean"
2111
1943
  },
2112
1944
  {
2113
- "name": "littleEndian",
2114
- "docs": "",
2115
- "type": "boolean | undefined"
1945
+ "name": "thisArg",
1946
+ "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.",
1947
+ "type": "any"
2116
1948
  }
2117
1949
  ],
2118
1950
  "returns": "number",
2119
1951
  "tags": [
2120
1952
  {
2121
1953
  "name": "param",
2122
- "text": "byteOffset The place in the buffer at which the value should be retrieved."
2123
- }
2124
- ],
2125
- "docs": "Gets the Float64 value at the specified byte offset from the start of the view. There is\r\nno alignment constraint; multi-byte values may be fetched from any offset.",
2126
- "complexTypes": [],
2127
- "slug": "getfloat64"
2128
- },
2129
- {
2130
- "name": "getInt8",
2131
- "signature": "(byteOffset: number) => number",
2132
- "parameters": [
2133
- {
2134
- "name": "byteOffset",
2135
- "docs": "The place in the buffer at which the value should be retrieved.",
2136
- "type": "number"
2137
- }
2138
- ],
2139
- "returns": "number",
2140
- "tags": [
1954
+ "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."
1955
+ },
2141
1956
  {
2142
1957
  "name": "param",
2143
- "text": "byteOffset The place in the buffer at which the value should be retrieved."
1958
+ "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."
2144
1959
  }
2145
1960
  ],
2146
- "docs": "Gets the Int8 value at the specified byte offset from the start of the view. There is\r\nno alignment constraint; multi-byte values may be fetched from any offset.",
2147
- "complexTypes": [],
2148
- "slug": "getint8"
1961
+ "docs": "Returns the index of the first element in the array where predicate is true, and -1\r\notherwise.",
1962
+ "complexTypes": [
1963
+ "Uint8Array"
1964
+ ],
1965
+ "slug": "findindex"
2149
1966
  },
2150
1967
  {
2151
- "name": "getInt16",
2152
- "signature": "(byteOffset: number, littleEndian?: boolean | undefined) => number",
1968
+ "name": "forEach",
1969
+ "signature": "(callbackfn: (value: number, index: number, array: Uint8Array) => void, thisArg?: any) => void",
2153
1970
  "parameters": [
2154
1971
  {
2155
- "name": "byteOffset",
2156
- "docs": "The place in the buffer at which the value should be retrieved.",
2157
- "type": "number"
1972
+ "name": "callbackfn",
1973
+ "docs": "A function that accepts up to three arguments. forEach calls the\r\ncallbackfn function one time for each element in the array.",
1974
+ "type": "(value: number, index: number, array: Uint8Array) => void"
2158
1975
  },
2159
1976
  {
2160
- "name": "littleEndian",
2161
- "docs": "",
2162
- "type": "boolean | undefined"
1977
+ "name": "thisArg",
1978
+ "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.",
1979
+ "type": "any"
2163
1980
  }
2164
1981
  ],
2165
- "returns": "number",
1982
+ "returns": "void",
2166
1983
  "tags": [
2167
1984
  {
2168
1985
  "name": "param",
2169
- "text": "byteOffset The place in the buffer at which the value should be retrieved."
1986
+ "text": "callbackfn A function that accepts up to three arguments. forEach calls the\r\ncallbackfn function one time for each element in the array."
1987
+ },
1988
+ {
1989
+ "name": "param",
1990
+ "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."
2170
1991
  }
2171
1992
  ],
2172
- "docs": "Gets the Int16 value at the specified byte offset from the start of the view. There is\r\nno alignment constraint; multi-byte values may be fetched from any offset.",
2173
- "complexTypes": [],
2174
- "slug": "getint16"
1993
+ "docs": "Performs the specified action for each element in an array.",
1994
+ "complexTypes": [
1995
+ "Uint8Array"
1996
+ ],
1997
+ "slug": "foreach"
2175
1998
  },
2176
1999
  {
2177
- "name": "getInt32",
2178
- "signature": "(byteOffset: number, littleEndian?: boolean | undefined) => number",
2000
+ "name": "indexOf",
2001
+ "signature": "(searchElement: number, fromIndex?: number | undefined) => number",
2179
2002
  "parameters": [
2180
2003
  {
2181
- "name": "byteOffset",
2182
- "docs": "The place in the buffer at which the value should be retrieved.",
2004
+ "name": "searchElement",
2005
+ "docs": "The value to locate in the array.",
2183
2006
  "type": "number"
2184
2007
  },
2185
2008
  {
2186
- "name": "littleEndian",
2187
- "docs": "",
2188
- "type": "boolean | undefined"
2009
+ "name": "fromIndex",
2010
+ "docs": "The array index at which to begin the search. If fromIndex is omitted, the\r\nsearch starts at index 0.",
2011
+ "type": "number | undefined"
2189
2012
  }
2190
2013
  ],
2191
2014
  "returns": "number",
2192
2015
  "tags": [
2193
2016
  {
2194
2017
  "name": "param",
2195
- "text": "byteOffset The place in the buffer at which the value should be retrieved."
2018
+ "text": "searchElement The value to locate in the array."
2019
+ },
2020
+ {
2021
+ "name": "param",
2022
+ "text": "fromIndex The array index at which to begin the search. If fromIndex is omitted, the\r\nsearch starts at index 0."
2196
2023
  }
2197
2024
  ],
2198
- "docs": "Gets the Int32 value at the specified byte offset from the start of the view. There is\r\nno alignment constraint; multi-byte values may be fetched from any offset.",
2025
+ "docs": "Returns the index of the first occurrence of a value in an array.",
2199
2026
  "complexTypes": [],
2200
- "slug": "getint32"
2027
+ "slug": "indexof"
2201
2028
  },
2202
2029
  {
2203
- "name": "getUint8",
2204
- "signature": "(byteOffset: number) => number",
2030
+ "name": "join",
2031
+ "signature": "(separator?: string | undefined) => string",
2205
2032
  "parameters": [
2206
2033
  {
2207
- "name": "byteOffset",
2208
- "docs": "The place in the buffer at which the value should be retrieved.",
2209
- "type": "number"
2034
+ "name": "separator",
2035
+ "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.",
2036
+ "type": "string | undefined"
2210
2037
  }
2211
2038
  ],
2212
- "returns": "number",
2039
+ "returns": "string",
2213
2040
  "tags": [
2214
2041
  {
2215
2042
  "name": "param",
2216
- "text": "byteOffset The place in the buffer at which the value should be retrieved."
2043
+ "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."
2217
2044
  }
2218
2045
  ],
2219
- "docs": "Gets the Uint8 value at the specified byte offset from the start of the view. There is\r\nno alignment constraint; multi-byte values may be fetched from any offset.",
2046
+ "docs": "Adds all the elements of an array separated by the specified separator string.",
2220
2047
  "complexTypes": [],
2221
- "slug": "getuint8"
2048
+ "slug": "join"
2222
2049
  },
2223
2050
  {
2224
- "name": "getUint16",
2225
- "signature": "(byteOffset: number, littleEndian?: boolean | undefined) => number",
2051
+ "name": "lastIndexOf",
2052
+ "signature": "(searchElement: number, fromIndex?: number | undefined) => number",
2226
2053
  "parameters": [
2227
2054
  {
2228
- "name": "byteOffset",
2229
- "docs": "The place in the buffer at which the value should be retrieved.",
2055
+ "name": "searchElement",
2056
+ "docs": "The value to locate in the array.",
2230
2057
  "type": "number"
2231
2058
  },
2232
2059
  {
2233
- "name": "littleEndian",
2234
- "docs": "",
2235
- "type": "boolean | undefined"
2060
+ "name": "fromIndex",
2061
+ "docs": "The array index at which to begin the search. If fromIndex is omitted, the\r\nsearch starts at index 0.",
2062
+ "type": "number | undefined"
2236
2063
  }
2237
2064
  ],
2238
2065
  "returns": "number",
2239
2066
  "tags": [
2240
2067
  {
2241
2068
  "name": "param",
2242
- "text": "byteOffset The place in the buffer at which the value should be retrieved."
2069
+ "text": "searchElement The value to locate in the array."
2070
+ },
2071
+ {
2072
+ "name": "param",
2073
+ "text": "fromIndex The array index at which to begin the search. If fromIndex is omitted, the\r\nsearch starts at index 0."
2243
2074
  }
2244
2075
  ],
2245
- "docs": "Gets the Uint16 value at the specified byte offset from the start of the view. There is\r\nno alignment constraint; multi-byte values may be fetched from any offset.",
2076
+ "docs": "Returns the index of the last occurrence of a value in an array.",
2246
2077
  "complexTypes": [],
2247
- "slug": "getuint16"
2078
+ "slug": "lastindexof"
2248
2079
  },
2249
2080
  {
2250
- "name": "getUint32",
2251
- "signature": "(byteOffset: number, littleEndian?: boolean | undefined) => number",
2081
+ "name": "map",
2082
+ "signature": "(callbackfn: (value: number, index: number, array: Uint8Array) => number, thisArg?: any) => Uint8Array",
2252
2083
  "parameters": [
2253
2084
  {
2254
- "name": "byteOffset",
2255
- "docs": "The place in the buffer at which the value should be retrieved.",
2256
- "type": "number"
2085
+ "name": "callbackfn",
2086
+ "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.",
2087
+ "type": "(value: number, index: number, array: Uint8Array) => number"
2257
2088
  },
2258
2089
  {
2259
- "name": "littleEndian",
2260
- "docs": "",
2261
- "type": "boolean | undefined"
2090
+ "name": "thisArg",
2091
+ "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.",
2092
+ "type": "any"
2262
2093
  }
2263
2094
  ],
2264
- "returns": "number",
2095
+ "returns": "Uint8Array",
2265
2096
  "tags": [
2266
2097
  {
2267
2098
  "name": "param",
2268
- "text": "byteOffset The place in the buffer at which the value should be retrieved."
2099
+ "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."
2100
+ },
2101
+ {
2102
+ "name": "param",
2103
+ "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."
2269
2104
  }
2270
2105
  ],
2271
- "docs": "Gets the Uint32 value at the specified byte offset from the start of the view. There is\r\nno alignment constraint; multi-byte values may be fetched from any offset.",
2272
- "complexTypes": [],
2273
- "slug": "getuint32"
2106
+ "docs": "Calls a defined callback function on each element of an array, and returns an array that\r\ncontains the results.",
2107
+ "complexTypes": [
2108
+ "Uint8Array"
2109
+ ],
2110
+ "slug": "map"
2274
2111
  },
2275
2112
  {
2276
- "name": "setFloat32",
2277
- "signature": "(byteOffset: number, value: number, littleEndian?: boolean | undefined) => void",
2113
+ "name": "reduce",
2114
+ "signature": "(callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: Uint8Array) => number) => number",
2278
2115
  "parameters": [
2279
2116
  {
2280
- "name": "byteOffset",
2281
- "docs": "The place in the buffer at which the value should be set.",
2282
- "type": "number"
2283
- },
2284
- {
2285
- "name": "value",
2286
- "docs": "The value to set.",
2287
- "type": "number"
2288
- },
2289
- {
2290
- "name": "littleEndian",
2291
- "docs": "If false or undefined, a big-endian value should be written,\r\notherwise a little-endian value should be written.",
2292
- "type": "boolean | undefined"
2117
+ "name": "callbackfn",
2118
+ "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.",
2119
+ "type": "(previousValue: number, currentValue: number, currentIndex: number, array: Uint8Array) => number"
2293
2120
  }
2294
2121
  ],
2295
- "returns": "void",
2122
+ "returns": "number",
2296
2123
  "tags": [
2297
2124
  {
2298
2125
  "name": "param",
2299
- "text": "byteOffset The place in the buffer at which the value should be set."
2300
- },
2301
- {
2302
- "name": "param",
2303
- "text": "value The value to set."
2126
+ "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."
2304
2127
  },
2305
2128
  {
2306
2129
  "name": "param",
2307
- "text": "littleEndian If false or undefined, a big-endian value should be written,\r\notherwise a little-endian value should be written."
2130
+ "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."
2308
2131
  }
2309
2132
  ],
2310
- "docs": "Stores an Float32 value at the specified byte offset from the start of the view.",
2311
- "complexTypes": [],
2312
- "slug": "setfloat32"
2133
+ "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.",
2134
+ "complexTypes": [
2135
+ "Uint8Array"
2136
+ ],
2137
+ "slug": "reduce"
2313
2138
  },
2314
2139
  {
2315
- "name": "setFloat64",
2316
- "signature": "(byteOffset: number, value: number, littleEndian?: boolean | undefined) => void",
2140
+ "name": "reduce",
2141
+ "signature": "(callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: Uint8Array) => number, initialValue: number) => number",
2317
2142
  "parameters": [
2318
2143
  {
2319
- "name": "byteOffset",
2320
- "docs": "The place in the buffer at which the value should be set.",
2321
- "type": "number"
2144
+ "name": "callbackfn",
2145
+ "docs": "",
2146
+ "type": "(previousValue: number, currentValue: number, currentIndex: number, array: Uint8Array) => number"
2322
2147
  },
2323
2148
  {
2324
- "name": "value",
2325
- "docs": "The value to set.",
2149
+ "name": "initialValue",
2150
+ "docs": "",
2326
2151
  "type": "number"
2152
+ }
2153
+ ],
2154
+ "returns": "number",
2155
+ "tags": [],
2156
+ "docs": "",
2157
+ "complexTypes": [
2158
+ "Uint8Array"
2159
+ ],
2160
+ "slug": "reduce"
2161
+ },
2162
+ {
2163
+ "name": "reduce",
2164
+ "signature": "<U>(callbackfn: (previousValue: U, currentValue: number, currentIndex: number, array: Uint8Array) => U, initialValue: U) => U",
2165
+ "parameters": [
2166
+ {
2167
+ "name": "callbackfn",
2168
+ "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.",
2169
+ "type": "(previousValue: U, currentValue: number, currentIndex: number, array: Uint8Array) => U"
2327
2170
  },
2328
2171
  {
2329
- "name": "littleEndian",
2330
- "docs": "If false or undefined, a big-endian value should be written,\r\notherwise a little-endian value should be written.",
2331
- "type": "boolean | undefined"
2172
+ "name": "initialValue",
2173
+ "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.",
2174
+ "type": "U"
2332
2175
  }
2333
2176
  ],
2334
- "returns": "void",
2177
+ "returns": "U",
2335
2178
  "tags": [
2336
2179
  {
2337
2180
  "name": "param",
2338
- "text": "byteOffset The place in the buffer at which the value should be set."
2339
- },
2340
- {
2341
- "name": "param",
2342
- "text": "value The value to set."
2181
+ "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."
2343
2182
  },
2344
2183
  {
2345
2184
  "name": "param",
2346
- "text": "littleEndian If false or undefined, a big-endian value should be written,\r\notherwise a little-endian value should be written."
2185
+ "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."
2347
2186
  }
2348
2187
  ],
2349
- "docs": "Stores an Float64 value at the specified byte offset from the start of the view.",
2350
- "complexTypes": [],
2351
- "slug": "setfloat64"
2188
+ "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.",
2189
+ "complexTypes": [
2190
+ "U",
2191
+ "Uint8Array"
2192
+ ],
2193
+ "slug": "reduce"
2352
2194
  },
2353
2195
  {
2354
- "name": "setInt8",
2355
- "signature": "(byteOffset: number, value: number) => void",
2196
+ "name": "reduceRight",
2197
+ "signature": "(callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: Uint8Array) => number) => number",
2356
2198
  "parameters": [
2357
2199
  {
2358
- "name": "byteOffset",
2359
- "docs": "The place in the buffer at which the value should be set.",
2360
- "type": "number"
2361
- },
2362
- {
2363
- "name": "value",
2364
- "docs": "The value to set.",
2365
- "type": "number"
2200
+ "name": "callbackfn",
2201
+ "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.",
2202
+ "type": "(previousValue: number, currentValue: number, currentIndex: number, array: Uint8Array) => number"
2366
2203
  }
2367
2204
  ],
2368
- "returns": "void",
2205
+ "returns": "number",
2369
2206
  "tags": [
2370
2207
  {
2371
2208
  "name": "param",
2372
- "text": "byteOffset The place in the buffer at which the value should be set."
2209
+ "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."
2373
2210
  },
2374
2211
  {
2375
2212
  "name": "param",
2376
- "text": "value The value to set."
2213
+ "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."
2377
2214
  }
2378
2215
  ],
2379
- "docs": "Stores an Int8 value at the specified byte offset from the start of the view.",
2380
- "complexTypes": [],
2381
- "slug": "setint8"
2216
+ "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.",
2217
+ "complexTypes": [
2218
+ "Uint8Array"
2219
+ ],
2220
+ "slug": "reduceright"
2382
2221
  },
2383
2222
  {
2384
- "name": "setInt16",
2385
- "signature": "(byteOffset: number, value: number, littleEndian?: boolean | undefined) => void",
2223
+ "name": "reduceRight",
2224
+ "signature": "(callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: Uint8Array) => number, initialValue: number) => number",
2386
2225
  "parameters": [
2387
2226
  {
2388
- "name": "byteOffset",
2389
- "docs": "The place in the buffer at which the value should be set.",
2390
- "type": "number"
2227
+ "name": "callbackfn",
2228
+ "docs": "",
2229
+ "type": "(previousValue: number, currentValue: number, currentIndex: number, array: Uint8Array) => number"
2391
2230
  },
2392
2231
  {
2393
- "name": "value",
2394
- "docs": "The value to set.",
2232
+ "name": "initialValue",
2233
+ "docs": "",
2395
2234
  "type": "number"
2235
+ }
2236
+ ],
2237
+ "returns": "number",
2238
+ "tags": [],
2239
+ "docs": "",
2240
+ "complexTypes": [
2241
+ "Uint8Array"
2242
+ ],
2243
+ "slug": "reduceright"
2244
+ },
2245
+ {
2246
+ "name": "reduceRight",
2247
+ "signature": "<U>(callbackfn: (previousValue: U, currentValue: number, currentIndex: number, array: Uint8Array) => U, initialValue: U) => U",
2248
+ "parameters": [
2249
+ {
2250
+ "name": "callbackfn",
2251
+ "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.",
2252
+ "type": "(previousValue: U, currentValue: number, currentIndex: number, array: Uint8Array) => U"
2396
2253
  },
2397
2254
  {
2398
- "name": "littleEndian",
2399
- "docs": "If false or undefined, a big-endian value should be written,\r\notherwise a little-endian value should be written.",
2400
- "type": "boolean | undefined"
2255
+ "name": "initialValue",
2256
+ "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.",
2257
+ "type": "U"
2401
2258
  }
2402
2259
  ],
2403
- "returns": "void",
2260
+ "returns": "U",
2404
2261
  "tags": [
2405
2262
  {
2406
2263
  "name": "param",
2407
- "text": "byteOffset The place in the buffer at which the value should be set."
2408
- },
2409
- {
2410
- "name": "param",
2411
- "text": "value The value to set."
2264
+ "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."
2412
2265
  },
2413
2266
  {
2414
2267
  "name": "param",
2415
- "text": "littleEndian If false or undefined, a big-endian value should be written,\r\notherwise a little-endian value should be written."
2268
+ "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."
2416
2269
  }
2417
2270
  ],
2418
- "docs": "Stores an Int16 value at the specified byte offset from the start of the view.",
2419
- "complexTypes": [],
2420
- "slug": "setint16"
2271
+ "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.",
2272
+ "complexTypes": [
2273
+ "U",
2274
+ "Uint8Array"
2275
+ ],
2276
+ "slug": "reduceright"
2421
2277
  },
2422
2278
  {
2423
- "name": "setInt32",
2424
- "signature": "(byteOffset: number, value: number, littleEndian?: boolean | undefined) => void",
2279
+ "name": "reverse",
2280
+ "signature": "() => Uint8Array",
2281
+ "parameters": [],
2282
+ "returns": "Uint8Array",
2283
+ "tags": [],
2284
+ "docs": "Reverses the elements in an Array.",
2285
+ "complexTypes": [
2286
+ "Uint8Array"
2287
+ ],
2288
+ "slug": "reverse"
2289
+ },
2290
+ {
2291
+ "name": "set",
2292
+ "signature": "(array: ArrayLike<number>, offset?: number | undefined) => void",
2425
2293
  "parameters": [
2426
2294
  {
2427
- "name": "byteOffset",
2428
- "docs": "The place in the buffer at which the value should be set.",
2429
- "type": "number"
2430
- },
2431
- {
2432
- "name": "value",
2433
- "docs": "The value to set.",
2434
- "type": "number"
2295
+ "name": "array",
2296
+ "docs": "A typed or untyped array of values to set.",
2297
+ "type": "ArrayLike<number>"
2435
2298
  },
2436
2299
  {
2437
- "name": "littleEndian",
2438
- "docs": "If false or undefined, a big-endian value should be written,\r\notherwise a little-endian value should be written.",
2439
- "type": "boolean | undefined"
2300
+ "name": "offset",
2301
+ "docs": "The index in the current array at which the values are to be written.",
2302
+ "type": "number | undefined"
2440
2303
  }
2441
2304
  ],
2442
2305
  "returns": "void",
2443
2306
  "tags": [
2444
2307
  {
2445
2308
  "name": "param",
2446
- "text": "byteOffset The place in the buffer at which the value should be set."
2447
- },
2448
- {
2449
- "name": "param",
2450
- "text": "value The value to set."
2309
+ "text": "array A typed or untyped array of values to set."
2451
2310
  },
2452
2311
  {
2453
2312
  "name": "param",
2454
- "text": "littleEndian If false or undefined, a big-endian value should be written,\r\notherwise a little-endian value should be written."
2313
+ "text": "offset The index in the current array at which the values are to be written."
2455
2314
  }
2456
2315
  ],
2457
- "docs": "Stores an Int32 value at the specified byte offset from the start of the view.",
2458
- "complexTypes": [],
2459
- "slug": "setint32"
2316
+ "docs": "Sets a value or an array of values.",
2317
+ "complexTypes": [
2318
+ "ArrayLike"
2319
+ ],
2320
+ "slug": "set"
2460
2321
  },
2461
2322
  {
2462
- "name": "setUint8",
2463
- "signature": "(byteOffset: number, value: number) => void",
2323
+ "name": "slice",
2324
+ "signature": "(start?: number | undefined, end?: number | undefined) => Uint8Array",
2464
2325
  "parameters": [
2465
2326
  {
2466
- "name": "byteOffset",
2467
- "docs": "The place in the buffer at which the value should be set.",
2468
- "type": "number"
2327
+ "name": "start",
2328
+ "docs": "The beginning of the specified portion of the array.",
2329
+ "type": "number | undefined"
2469
2330
  },
2470
2331
  {
2471
- "name": "value",
2472
- "docs": "The value to set.",
2473
- "type": "number"
2332
+ "name": "end",
2333
+ "docs": "The end of the specified portion of the array. This is exclusive of the element at the index 'end'.",
2334
+ "type": "number | undefined"
2474
2335
  }
2475
2336
  ],
2476
- "returns": "void",
2337
+ "returns": "Uint8Array",
2477
2338
  "tags": [
2478
2339
  {
2479
2340
  "name": "param",
2480
- "text": "byteOffset The place in the buffer at which the value should be set."
2341
+ "text": "start The beginning of the specified portion of the array."
2481
2342
  },
2482
2343
  {
2483
2344
  "name": "param",
2484
- "text": "value The value to set."
2345
+ "text": "end The end of the specified portion of the array. This is exclusive of the element at the index 'end'."
2485
2346
  }
2486
2347
  ],
2487
- "docs": "Stores an Uint8 value at the specified byte offset from the start of the view.",
2488
- "complexTypes": [],
2489
- "slug": "setuint8"
2348
+ "docs": "Returns a section of an array.",
2349
+ "complexTypes": [
2350
+ "Uint8Array"
2351
+ ],
2352
+ "slug": "slice"
2490
2353
  },
2491
2354
  {
2492
- "name": "setUint16",
2493
- "signature": "(byteOffset: number, value: number, littleEndian?: boolean | undefined) => void",
2355
+ "name": "some",
2356
+ "signature": "(predicate: (value: number, index: number, array: Uint8Array) => unknown, thisArg?: any) => boolean",
2494
2357
  "parameters": [
2495
2358
  {
2496
- "name": "byteOffset",
2497
- "docs": "The place in the buffer at which the value should be set.",
2498
- "type": "number"
2499
- },
2500
- {
2501
- "name": "value",
2502
- "docs": "The value to set.",
2503
- "type": "number"
2359
+ "name": "predicate",
2360
+ "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.",
2361
+ "type": "(value: number, index: number, array: Uint8Array) => unknown"
2504
2362
  },
2505
2363
  {
2506
- "name": "littleEndian",
2507
- "docs": "If false or undefined, a big-endian value should be written,\r\notherwise a little-endian value should be written.",
2508
- "type": "boolean | undefined"
2364
+ "name": "thisArg",
2365
+ "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.",
2366
+ "type": "any"
2509
2367
  }
2510
2368
  ],
2511
- "returns": "void",
2369
+ "returns": "boolean",
2512
2370
  "tags": [
2513
2371
  {
2514
2372
  "name": "param",
2515
- "text": "byteOffset The place in the buffer at which the value should be set."
2373
+ "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."
2516
2374
  },
2517
2375
  {
2518
2376
  "name": "param",
2519
- "text": "value The value to set."
2520
- },
2377
+ "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."
2378
+ }
2379
+ ],
2380
+ "docs": "Determines whether the specified callback function returns true for any element of an array.",
2381
+ "complexTypes": [
2382
+ "Uint8Array"
2383
+ ],
2384
+ "slug": "some"
2385
+ },
2386
+ {
2387
+ "name": "sort",
2388
+ "signature": "(compareFn?: ((a: number, b: number) => number) | undefined) => this",
2389
+ "parameters": [
2390
+ {
2391
+ "name": "compareFn",
2392
+ "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```",
2393
+ "type": "((a: number, b: number) => number) | undefined"
2394
+ }
2395
+ ],
2396
+ "returns": "this",
2397
+ "tags": [
2521
2398
  {
2522
2399
  "name": "param",
2523
- "text": "littleEndian If false or undefined, a big-endian value should be written,\r\notherwise a little-endian value should be written."
2400
+ "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```"
2524
2401
  }
2525
2402
  ],
2526
- "docs": "Stores an Uint16 value at the specified byte offset from the start of the view.",
2403
+ "docs": "Sorts an array.",
2527
2404
  "complexTypes": [],
2528
- "slug": "setuint16"
2405
+ "slug": "sort"
2529
2406
  },
2530
2407
  {
2531
- "name": "setUint32",
2532
- "signature": "(byteOffset: number, value: number, littleEndian?: boolean | undefined) => void",
2408
+ "name": "subarray",
2409
+ "signature": "(begin?: number | undefined, end?: number | undefined) => Uint8Array",
2533
2410
  "parameters": [
2534
2411
  {
2535
- "name": "byteOffset",
2536
- "docs": "The place in the buffer at which the value should be set.",
2537
- "type": "number"
2538
- },
2539
- {
2540
- "name": "value",
2541
- "docs": "The value to set.",
2542
- "type": "number"
2412
+ "name": "begin",
2413
+ "docs": "The index of the beginning of the array.",
2414
+ "type": "number | undefined"
2543
2415
  },
2544
2416
  {
2545
- "name": "littleEndian",
2546
- "docs": "If false or undefined, a big-endian value should be written,\r\notherwise a little-endian value should be written.",
2547
- "type": "boolean | undefined"
2417
+ "name": "end",
2418
+ "docs": "The index of the end of the array.",
2419
+ "type": "number | undefined"
2548
2420
  }
2549
2421
  ],
2550
- "returns": "void",
2422
+ "returns": "Uint8Array",
2551
2423
  "tags": [
2552
2424
  {
2553
2425
  "name": "param",
2554
- "text": "byteOffset The place in the buffer at which the value should be set."
2555
- },
2556
- {
2557
- "name": "param",
2558
- "text": "value The value to set."
2426
+ "text": "begin The index of the beginning of the array."
2559
2427
  },
2560
2428
  {
2561
2429
  "name": "param",
2562
- "text": "littleEndian If false or undefined, a big-endian value should be written,\r\notherwise a little-endian value should be written."
2430
+ "text": "end The index of the end of the array."
2563
2431
  }
2564
2432
  ],
2565
- "docs": "Stores an Uint32 value at the specified byte offset from the start of the view.",
2433
+ "docs": "Gets a new Uint8Array view of the ArrayBuffer store for this array, referencing the elements\r\nat begin, inclusive, up to end, exclusive.",
2434
+ "complexTypes": [
2435
+ "Uint8Array"
2436
+ ],
2437
+ "slug": "subarray"
2438
+ },
2439
+ {
2440
+ "name": "toLocaleString",
2441
+ "signature": "() => string",
2442
+ "parameters": [],
2443
+ "returns": "string",
2444
+ "tags": [],
2445
+ "docs": "Converts a number to a string by using the current locale.",
2566
2446
  "complexTypes": [],
2567
- "slug": "setuint32"
2447
+ "slug": "tolocalestring"
2448
+ },
2449
+ {
2450
+ "name": "toString",
2451
+ "signature": "() => string",
2452
+ "parameters": [],
2453
+ "returns": "string",
2454
+ "tags": [],
2455
+ "docs": "Returns a string representation of an array.",
2456
+ "complexTypes": [],
2457
+ "slug": "tostring"
2458
+ },
2459
+ {
2460
+ "name": "valueOf",
2461
+ "signature": "() => Uint8Array",
2462
+ "parameters": [],
2463
+ "returns": "Uint8Array",
2464
+ "tags": [],
2465
+ "docs": "Returns the primitive value of the specified object.",
2466
+ "complexTypes": [
2467
+ "Uint8Array"
2468
+ ],
2469
+ "slug": "valueof"
2568
2470
  }
2569
2471
  ],
2570
2472
  "properties": [
2473
+ {
2474
+ "name": "BYTES_PER_ELEMENT",
2475
+ "tags": [],
2476
+ "docs": "The size in bytes of each element in the array.",
2477
+ "complexTypes": [],
2478
+ "type": "number"
2479
+ },
2571
2480
  {
2572
2481
  "name": "buffer",
2573
2482
  "tags": [],
2574
- "docs": "",
2483
+ "docs": "The ArrayBuffer instance referenced by the array.",
2575
2484
  "complexTypes": [
2576
- "ArrayBuffer"
2485
+ "ArrayBufferLike"
2577
2486
  ],
2578
- "type": "ArrayBuffer"
2487
+ "type": "ArrayBufferLike"
2579
2488
  },
2580
2489
  {
2581
2490
  "name": "byteLength",
2582
2491
  "tags": [],
2583
- "docs": "",
2492
+ "docs": "The length in bytes of the array.",
2584
2493
  "complexTypes": [],
2585
2494
  "type": "number"
2586
2495
  },
2587
2496
  {
2588
2497
  "name": "byteOffset",
2589
2498
  "tags": [],
2499
+ "docs": "The offset in bytes of the array.",
2500
+ "complexTypes": [],
2501
+ "type": "number"
2502
+ },
2503
+ {
2504
+ "name": "length",
2505
+ "tags": [],
2506
+ "docs": "The length of the array.",
2507
+ "complexTypes": [],
2508
+ "type": "number"
2509
+ }
2510
+ ]
2511
+ },
2512
+ {
2513
+ "name": "ArrayLike",
2514
+ "slug": "arraylike",
2515
+ "docs": "",
2516
+ "tags": [],
2517
+ "methods": [],
2518
+ "properties": [
2519
+ {
2520
+ "name": "length",
2521
+ "tags": [],
2590
2522
  "docs": "",
2591
2523
  "complexTypes": [],
2592
2524
  "type": "number"
2593
2525
  }
2594
2526
  ]
2595
2527
  },
2528
+ {
2529
+ "name": "ArrayBufferTypes",
2530
+ "slug": "arraybuffertypes",
2531
+ "docs": "Allowed ArrayBuffer types for the buffer of an ArrayBufferView and related Typed Arrays.",
2532
+ "tags": [],
2533
+ "methods": [],
2534
+ "properties": [
2535
+ {
2536
+ "name": "ArrayBuffer",
2537
+ "tags": [],
2538
+ "docs": "",
2539
+ "complexTypes": [
2540
+ "ArrayBuffer"
2541
+ ],
2542
+ "type": "ArrayBuffer"
2543
+ }
2544
+ ]
2545
+ },
2546
+ {
2547
+ "name": "ServiceDataFilter",
2548
+ "slug": "servicedatafilter",
2549
+ "docs": "",
2550
+ "tags": [],
2551
+ "methods": [],
2552
+ "properties": [
2553
+ {
2554
+ "name": "serviceUuid",
2555
+ "tags": [],
2556
+ "docs": "Service UUID to filter by. The service data must be associated with this UUID.\r\nUUIDs have to be specified as 128 bit UUID strings,\r\ne.g. '0000fffa-0000-1000-8000-00805f9b34fb'",
2557
+ "complexTypes": [],
2558
+ "type": "string"
2559
+ },
2560
+ {
2561
+ "name": "dataPrefix",
2562
+ "tags": [],
2563
+ "docs": "Prefix to match in the service data field.\r\nFor example, OpenDroneID uses [0x0D] as the advertisement code.\r\nandroid, ios: string\r\nweb: DataView",
2564
+ "complexTypes": [
2565
+ "DataView"
2566
+ ],
2567
+ "type": "DataView"
2568
+ },
2569
+ {
2570
+ "name": "mask",
2571
+ "tags": [],
2572
+ "docs": "Set filter on partial service data. For any bit in the mask, set it to 1 if it needs to match the one in service data, otherwise set it to 0.\r\nThe `mask` must have the same length as dataPrefix.\r\nandroid, ios: string\r\nweb: DataView",
2573
+ "complexTypes": [
2574
+ "DataView"
2575
+ ],
2576
+ "type": "DataView"
2577
+ }
2578
+ ]
2579
+ },
2580
+ {
2581
+ "name": "ScanResult",
2582
+ "slug": "scanresult",
2583
+ "docs": "",
2584
+ "tags": [],
2585
+ "methods": [],
2586
+ "properties": [
2587
+ {
2588
+ "name": "device",
2589
+ "tags": [],
2590
+ "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.",
2591
+ "complexTypes": [
2592
+ "BleDevice"
2593
+ ],
2594
+ "type": "BleDevice"
2595
+ },
2596
+ {
2597
+ "name": "localName",
2598
+ "tags": [],
2599
+ "docs": "The name of the peripheral device from the advertisement data.",
2600
+ "complexTypes": [],
2601
+ "type": "string | undefined"
2602
+ },
2603
+ {
2604
+ "name": "rssi",
2605
+ "tags": [],
2606
+ "docs": "Received Signal Strength Indication.",
2607
+ "complexTypes": [],
2608
+ "type": "number | undefined"
2609
+ },
2610
+ {
2611
+ "name": "txPower",
2612
+ "tags": [],
2613
+ "docs": "Transmit power in dBm. A value of 127 indicates that it is not available.",
2614
+ "complexTypes": [],
2615
+ "type": "number | undefined"
2616
+ },
2617
+ {
2618
+ "name": "manufacturerData",
2619
+ "tags": [],
2620
+ "docs": "Manufacturer data, key is a company identifier and value is the data.",
2621
+ "complexTypes": [
2622
+ "DataView"
2623
+ ],
2624
+ "type": "{ [key: string]: DataView; } | undefined"
2625
+ },
2626
+ {
2627
+ "name": "serviceData",
2628
+ "tags": [],
2629
+ "docs": "Service data, key is a service UUID and value is the data.",
2630
+ "complexTypes": [
2631
+ "DataView"
2632
+ ],
2633
+ "type": "{ [key: string]: DataView; } | undefined"
2634
+ },
2635
+ {
2636
+ "name": "uuids",
2637
+ "tags": [],
2638
+ "docs": "Advertised services.",
2639
+ "complexTypes": [],
2640
+ "type": "string[] | undefined"
2641
+ },
2642
+ {
2643
+ "name": "rawAdvertisement",
2644
+ "tags": [],
2645
+ "docs": "Raw advertisement data (**Android** only).",
2646
+ "complexTypes": [
2647
+ "DataView"
2648
+ ],
2649
+ "type": "DataView"
2650
+ }
2651
+ ]
2652
+ },
2596
2653
  {
2597
2654
  "name": "TimeoutOptions",
2598
2655
  "slug": "timeoutoptions",
@@ -2603,7 +2660,7 @@
2603
2660
  {
2604
2661
  "name": "timeout",
2605
2662
  "tags": [],
2606
- "docs": "Timeout in milliseconds for plugin call.\nDefault is 10000 for `connect` and 5000 for other plugin methods.",
2663
+ "docs": "Timeout in milliseconds for plugin call.\r\nDefault is 10000 for `connect` and 5000 for other plugin methods.",
2607
2664
  "complexTypes": [],
2608
2665
  "type": "number | undefined"
2609
2666
  }
@@ -2787,19 +2844,19 @@
2787
2844
  "name": "SCAN_MODE_LOW_POWER",
2788
2845
  "value": "0",
2789
2846
  "tags": [],
2790
- "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"
2847
+ "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"
2791
2848
  },
2792
2849
  {
2793
2850
  "name": "SCAN_MODE_BALANCED",
2794
2851
  "value": "1",
2795
2852
  "tags": [],
2796
- "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"
2853
+ "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"
2797
2854
  },
2798
2855
  {
2799
2856
  "name": "SCAN_MODE_LOW_LATENCY",
2800
2857
  "value": "2",
2801
2858
  "tags": [],
2802
- "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"
2859
+ "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"
2803
2860
  }
2804
2861
  ]
2805
2862
  },
@@ -2811,19 +2868,19 @@
2811
2868
  "name": "CONNECTION_PRIORITY_BALANCED",
2812
2869
  "value": "0",
2813
2870
  "tags": [],
2814
- "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"
2871
+ "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"
2815
2872
  },
2816
2873
  {
2817
2874
  "name": "CONNECTION_PRIORITY_HIGH",
2818
2875
  "value": "1",
2819
2876
  "tags": [],
2820
- "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"
2877
+ "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"
2821
2878
  },
2822
2879
  {
2823
2880
  "name": "CONNECTION_PRIORITY_LOW_POWER",
2824
2881
  "value": "2",
2825
2882
  "tags": [],
2826
- "docs": "Request low power, reduced data rate connection parameters.\nhttps://developer.android.com/reference/android/bluetooth/BluetoothGatt#CONNECTION_PRIORITY_LOW_POWER"
2883
+ "docs": "Request low power, reduced data rate connection parameters.\r\nhttps://developer.android.com/reference/android/bluetooth/BluetoothGatt#CONNECTION_PRIORITY_LOW_POWER"
2827
2884
  }
2828
2885
  ]
2829
2886
  }