@capacitor-community/bluetooth-le 7.1.1 → 7.3.0

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