@kingstinct/react-native-healthkit 7.0.4 → 7.0.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (49) hide show
  1. package/README.md +7 -31
  2. package/ios/ReactNativeHealthkit.swift +3 -2
  3. package/lib/commonjs/hooks/useIsHealthDataAvailable.js +5 -0
  4. package/lib/commonjs/hooks/useIsHealthDataAvailable.js.map +1 -1
  5. package/lib/commonjs/index.ios.js +121 -15
  6. package/lib/commonjs/index.ios.js.map +1 -1
  7. package/lib/commonjs/index.js +3 -1
  8. package/lib/commonjs/index.js.map +1 -1
  9. package/lib/commonjs/jest.setup.js +1 -0
  10. package/lib/commonjs/jest.setup.js.map +1 -1
  11. package/lib/commonjs/native-types.js +36 -27
  12. package/lib/commonjs/native-types.js.map +1 -1
  13. package/lib/commonjs/types.js.map +1 -1
  14. package/lib/commonjs/utils/getMostRecentCategorySample.js +1 -1
  15. package/lib/commonjs/utils/getMostRecentCategorySample.js.map +1 -1
  16. package/lib/commonjs/utils/getMostRecentQuantitySample.js +5 -1
  17. package/lib/commonjs/utils/getMostRecentQuantitySample.js.map +1 -1
  18. package/lib/module/hooks/useIsHealthDataAvailable.js +6 -0
  19. package/lib/module/hooks/useIsHealthDataAvailable.js.map +1 -1
  20. package/lib/module/index.ios.js +119 -15
  21. package/lib/module/index.ios.js.map +1 -1
  22. package/lib/module/index.js +3 -1
  23. package/lib/module/index.js.map +1 -1
  24. package/lib/module/jest.setup.js +1 -0
  25. package/lib/module/jest.setup.js.map +1 -1
  26. package/lib/module/native-types.js +36 -27
  27. package/lib/module/native-types.js.map +1 -1
  28. package/lib/module/types.js +59 -0
  29. package/lib/module/types.js.map +1 -1
  30. package/lib/module/utils/getMostRecentCategorySample.js +1 -1
  31. package/lib/module/utils/getMostRecentCategorySample.js.map +1 -1
  32. package/lib/module/utils/getMostRecentQuantitySample.js +5 -1
  33. package/lib/module/utils/getMostRecentQuantitySample.js.map +1 -1
  34. package/lib/typescript/src/hooks/useIsHealthDataAvailable.d.ts +5 -0
  35. package/lib/typescript/src/index.d.ts +50 -3
  36. package/lib/typescript/src/index.ios.d.ts +84 -3
  37. package/lib/typescript/src/native-types.d.ts +515 -34
  38. package/lib/typescript/src/types.d.ts +49 -0
  39. package/lib/typescript/src/utils/getMostRecentCategorySample.d.ts +2 -1
  40. package/lib/typescript/src/utils/getMostRecentQuantitySample.d.ts +2 -1
  41. package/package.json +1 -1
  42. package/src/hooks/useIsHealthDataAvailable.ts +5 -0
  43. package/src/index.ios.tsx +132 -21
  44. package/src/index.tsx +6 -4
  45. package/src/jest.setup.ts +1 -0
  46. package/src/native-types.ts +615 -81
  47. package/src/types.ts +51 -2
  48. package/src/utils/getMostRecentCategorySample.ts +3 -2
  49. package/src/utils/getMostRecentQuantitySample.ts +9 -2
@@ -1,156 +1,674 @@
1
- import { NativeEventEmitter, NativeModules, Platform } from 'react-native'
1
+ import { NativeEventEmitter, NativeModules } from 'react-native'
2
2
 
3
3
  import type { EmitterSubscription, NativeModule } from 'react-native'
4
4
 
5
5
  /**
6
- * See https://developer.apple.com/documentation/healthkit/hkworkouttypeidentifier
6
+ * Represents a workout type identifier.
7
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkworkouttypeidentifier Apple Docs HKWorkoutTypeIdentifier}
7
8
  */
8
9
  export const HKWorkoutTypeIdentifier = 'HKWorkoutTypeIdentifier' as const
10
+
11
+ /**
12
+ * Represents an audiogram type identifier.
13
+ */
9
14
  export const HKAudiogramTypeIdentifier = 'HKAudiogramTypeIdentifier' as const
10
15
 
11
16
  /**
12
- * See https://developer.apple.com/documentation/healthkit/hkworkoutroutetypeidentifier
17
+ * Represents a workout route type identifier.
18
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkworkoutroutetypeidentifier Apple Docs HKWorkoutRouteTypeIdentifier}
13
19
  */
14
20
  export const HKWorkoutRouteTypeIdentifier = 'HKWorkoutRouteTypeIdentifier' as const
15
21
  export const HKDataTypeIdentifierHeartbeatSeries = 'HKDataTypeIdentifierHeartbeatSeries' as const
16
22
 
17
23
  /**
18
- * See https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifier
24
+ * Represents a quantity type identifier.
25
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifier Apple Docs HKQuantityTypeIdentifier}
19
26
  */
20
27
  export enum HKQuantityTypeIdentifier {
28
+ /**
29
+ * Body Mass Index
30
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierbodymassindex Apple Docs HKQuantityTypeIdentifierBodyMassIndex}
31
+ */
21
32
  bodyMassIndex = 'HKQuantityTypeIdentifierBodyMassIndex',
22
- bodyFatPercentage = 'HKQuantityTypeIdentifierBodyFatPercentage', // Scalar(Percent, 0.0 - 1.0), Discrete
23
- height = 'HKQuantityTypeIdentifierHeight', // Length, Discrete
24
- bodyMass = 'HKQuantityTypeIdentifierBodyMass', // Mass, Discrete
25
- leanBodyMass = 'HKQuantityTypeIdentifierLeanBodyMass', // Mass, Discrete
26
-
27
- waistCircumference = 'HKQuantityTypeIdentifierWaistCircumference', // Length, Discrete
28
- // Fitness
29
- stepCount = 'HKQuantityTypeIdentifierStepCount', // Scalar(Count), Cumulative
30
- distanceWalkingRunning = 'HKQuantityTypeIdentifierDistanceWalkingRunning', // Length, Cumulative
31
- distanceCycling = 'HKQuantityTypeIdentifierDistanceCycling', // Length, Cumulative
32
- distanceWheelchair = 'HKQuantityTypeIdentifierDistanceWheelchair', // Length, Cumulative
33
+
34
+ /**
35
+ * Body Fat Percentage
36
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierbodyfatpercentage Apple Docs HKQuantityTypeIdentifierBodyFatPercentage}
37
+ */
38
+ bodyFatPercentage = 'HKQuantityTypeIdentifierBodyFatPercentage',
39
+
40
+ /**
41
+ * Height
42
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierheight Apple Docs HKQuantityTypeIdentifierHeight}
43
+ */
44
+ height = 'HKQuantityTypeIdentifierHeight',
45
+
46
+ /**
47
+ * Body Mass
48
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierbodymass Apple Docs HKQuantityTypeIdentifierBodyMass}
49
+ */
50
+ bodyMass = 'HKQuantityTypeIdentifierBodyMass',
51
+
52
+ /**
53
+ * Lean Body Mass
54
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierleanbodymass Apple Docs HKQuantityTypeIdentifierLeanBodyMass}
55
+ */
56
+ leanBodyMass = 'HKQuantityTypeIdentifierLeanBodyMass',
57
+
58
+ /**
59
+ * Waist Circumference
60
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierwaistcircumference Apple Docs HKQuantityTypeIdentifierWaistCircumference}
61
+ */
62
+ waistCircumference = 'HKQuantityTypeIdentifierWaistCircumference',
63
+
64
+ /**
65
+ * Step Count
66
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierstepcount Apple Docs HKQuantityTypeIdentifierStepCount}
67
+ */
68
+ stepCount = 'HKQuantityTypeIdentifierStepCount',
69
+
70
+ /**
71
+ * Distance Walking Running
72
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierdistancewalkingrunning Apple Docs HKQuantityTypeIdentifierDistanceWalkingRunning}
73
+ */
74
+ distanceWalkingRunning = 'HKQuantityTypeIdentifierDistanceWalkingRunning',
75
+
76
+ /**
77
+ * Distance Cycling
78
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierdistancecycling Apple Docs HKQuantityTypeIdentifierDistanceCycling}
79
+ */
80
+ distanceCycling = 'HKQuantityTypeIdentifierDistanceCycling',
81
+
82
+ /**
83
+ * Distance Wheelchair
84
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierdistancewheelchair Apple Docs HKQuantityTypeIdentifierDistanceWheelchair}
85
+ */
86
+ distanceWheelchair = 'HKQuantityTypeIdentifierDistanceWheelchair',
87
+ /**
88
+ * Basal Energy Burned
89
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierbasalenergyburned Apple Docs HKQuantityTypeIdentifierBasalEnergyBurned}
90
+ */
33
91
  basalEnergyBurned = 'HKQuantityTypeIdentifierBasalEnergyBurned', // Energy, Cumulative
92
+ /**
93
+ * Active Energy Burned
94
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifieractiveenergyburned Apple Docs HKQuantityTypeIdentifierActiveEnergyBurned}
95
+ */
34
96
  activeEnergyBurned = 'HKQuantityTypeIdentifierActiveEnergyBurned', // Energy, Cumulative
97
+ /**
98
+ * Flights Climbed
99
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierflightsclimbed Apple Docs HKQuantityTypeIdentifierFlightsClimbed}
100
+ */
35
101
  flightsClimbed = 'HKQuantityTypeIdentifierFlightsClimbed', // Scalar(Count), Cumulative
102
+ /**
103
+ * Nike Fuel
104
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifiernikefuel Apple Docs HKQuantityTypeIdentifierNikeFuel}
105
+ */
36
106
  nikeFuel = 'HKQuantityTypeIdentifierNikeFuel', // Scalar(Count), Cumulative
107
+ /**
108
+ * Apple Exercise Time
109
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierappleexercisetime Apple Docs HKQuantityTypeIdentifierAppleExerciseTime}
110
+ */
37
111
  appleExerciseTime = 'HKQuantityTypeIdentifierAppleExerciseTime', // Time Cumulative
112
+ /**
113
+ * Push Count
114
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierpushcount Apple Docs HKQuantityTypeIdentifierPushCount}
115
+ */
38
116
  pushCount = 'HKQuantityTypeIdentifierPushCount', // Scalar(Count), Cumulative
117
+ /**
118
+ * Distance Swimming
119
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierdistanceswimming Apple Docs HKQuantityTypeIdentifierDistanceSwimming}
120
+ */
39
121
  distanceSwimming = 'HKQuantityTypeIdentifierDistanceSwimming', // Length, Cumulative
122
+ /**
123
+ * Swimming Stroke Count
124
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierswimmingstrokecount Apple Docs HKQuantityTypeIdentifierSwimmingStrokeCount}
125
+ */
40
126
  swimmingStrokeCount = 'HKQuantityTypeIdentifierSwimmingStrokeCount', // Scalar(Count), Cumulative
127
+ /**
128
+ * VO2 Max
129
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifiervo2max Apple Docs HKQuantityTypeIdentifierVO2Max}
130
+ */
41
131
  vo2Max = 'HKQuantityTypeIdentifierVO2Max', // ml/(kg*min) Discrete
132
+ /**
133
+ * Distance Downhill Snow Sports
134
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierdistancedownhillsnowsports Apple Docs HKQuantityTypeIdentifierDistanceDownhillSnowSports}
135
+ */
42
136
  distanceDownhillSnowSports = 'HKQuantityTypeIdentifierDistanceDownhillSnowSports', // Length, Cumulative
43
137
 
138
+ /**
139
+ * Apple Stand Time
140
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierapplestandtime Apple Docs HKQuantityTypeIdentifierAppleStandTime}
141
+ */
44
142
  appleStandTime = 'HKQuantityTypeIdentifierAppleStandTime', // Time, Cumulative
45
143
  // Vitals
144
+ /**
145
+ * Heart Rate
146
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierheartrate Apple Docs HKQuantityTypeIdentifierHeartRate}
147
+ */
46
148
  heartRate = 'HKQuantityTypeIdentifierHeartRate', // Scalar(Count)/Time, Discrete
149
+ /**
150
+ * Body Temperature
151
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierbodytemperature Apple Docs HKQuantityTypeIdentifierBodyTemperature}
152
+ */
47
153
  bodyTemperature = 'HKQuantityTypeIdentifierBodyTemperature', // Temperature, Discrete
154
+ /**
155
+ * Basal Body Temperature
156
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierbasalbodytemperature Apple Docs HKQuantityTypeIdentifierBasalBodyTemperature}
157
+ */
48
158
  basalBodyTemperature = 'HKQuantityTypeIdentifierBasalBodyTemperature', // Basal Body Temperature, Discrete
159
+ /**
160
+ * Blood Pressure Systolic
161
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierbloodpressuresystolic Apple Docs HKQuantityTypeIdentifierBloodPressureSystolic}
162
+ */
49
163
  bloodPressureSystolic = 'HKQuantityTypeIdentifierBloodPressureSystolic', // Pressure, Discrete
164
+ /**
165
+ * Blood Pressure Diastolic
166
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierbloodpressurediastolic Apple Docs HKQuantityTypeIdentifierBloodPressureDiastolic}
167
+ */
50
168
  bloodPressureDiastolic = 'HKQuantityTypeIdentifierBloodPressureDiastolic', // Pressure, Discrete
169
+ /**
170
+ * Respiratory Rate
171
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierrespiratoryrate Apple Docs HKQuantityTypeIdentifierRespiratoryRate}
172
+ */
51
173
  respiratoryRate = 'HKQuantityTypeIdentifierRespiratoryRate', // Scalar(Count)/Time, Discrete
52
- // Beats per minute estimate of a user's lowest heart rate while at rest
174
+ /**
175
+ * Resting Heart Rate
176
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierrestingheartrate Apple Docs HKQuantityTypeIdentifierRestingHeartRate}
177
+ */
53
178
  restingHeartRate = 'HKQuantityTypeIdentifierRestingHeartRate', // Scalar(Count)/Time, Discrete
54
- // Average heartbeats per minute captured by an Apple Watch while a user is walking
179
+ /**
180
+ * Walking Heart Rate Average
181
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierwalkingheartrateaverage Apple Docs HKQuantityTypeIdentifierWalkingHeartRateAverage}
182
+ * @since iOS 11.0
183
+ */
55
184
  walkingHeartRateAverage = 'HKQuantityTypeIdentifierWalkingHeartRateAverage', // Scalar(Count)/Time, Discrete
56
- // The standard deviation of heart beat-to-beat intevals (Standard Deviation of Normal to Normal)
57
-
185
+ /**
186
+ * Heart Rate Variability SDNN
187
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierheartratevariabilitysdnn Apple Docs HKQuantityTypeIdentifierHeartRateVariabilitySDNN}
188
+ * @since iOS 11.0
189
+ */
58
190
  heartRateVariabilitySDNN = 'HKQuantityTypeIdentifierHeartRateVariabilitySDNN', // Time (ms), Discrete
59
- // Results
60
- oxygenSaturation = 'HKQuantityTypeIdentifierOxygenSaturation', // Scalar (Percent, 0.0 - 1.0, Discrete
191
+ /**
192
+ * Oxygen Saturation
193
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifieroxygensaturation Apple Docs HKQuantityTypeIdentifierOxygenSaturation}
194
+ * @since iOS 8.0
195
+ */
196
+ oxygenSaturation = 'HKQuantityTypeIdentifierOxygenSaturation',
197
+ /**
198
+ * Peripheral Perfusion Index
199
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierperipheralperfusionindex Apple Docs HKQuantityTypeIdentifierPeripheralPerfusionIndex}
200
+ * @since iOS 8.0
201
+ */
61
202
  peripheralPerfusionIndex = 'HKQuantityTypeIdentifierPeripheralPerfusionIndex', // Scalar(Percent, 0.0 - 1.0), Discrete
62
- bloodGlucose = 'HKQuantityTypeIdentifierBloodGlucose', // Mass/Volume, Discrete
63
- numberOfTimesFallen = 'HKQuantityTypeIdentifierNumberOfTimesFallen', // Scalar(Count), Cumulative
64
- electrodermalActivity = 'HKQuantityTypeIdentifierElectrodermalActivity', // Conductance, Discrete
65
- inhalerUsage = 'HKQuantityTypeIdentifierInhalerUsage', // Scalar(Count), Cumulative
66
- insulinDelivery = 'HKQuantityTypeIdentifierInsulinDelivery', // Pharmacology (IU) Cumulative
67
- bloodAlcoholContent = 'HKQuantityTypeIdentifierBloodAlcoholContent', // Scalar(Percent, 0.0 - 1.0), Discrete
68
- forcedVitalCapacity = 'HKQuantityTypeIdentifierForcedVitalCapacity', // Volume, Discrete
69
- forcedExpiratoryVolume1 = 'HKQuantityTypeIdentifierForcedExpiratoryVolume1', // Volume, Discrete
70
- peakExpiratoryFlowRate = 'HKQuantityTypeIdentifierPeakExpiratoryFlowRate', // Volume/Time, Discrete
71
- environmentalAudioExposure = 'HKQuantityTypeIdentifierEnvironmentalAudioExposure', // Pressure, Cumulative
72
-
73
- headphoneAudioExposure = 'HKQuantityTypeIdentifierHeadphoneAudioExposure', // Pressure, Cumulative
203
+ /**
204
+ * Blood Glucose
205
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierbloodglucose Apple Docs HKQuantityTypeIdentifierBloodGlucose}
206
+ */
207
+ bloodGlucose = 'HKQuantityTypeIdentifierBloodGlucose',
208
+
209
+ /**
210
+ * Number Of Times Fallen
211
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifiernumberoftimesfallen Apple Docs HKQuantityTypeIdentifierNumberOfTimesFallen}
212
+ */
213
+ numberOfTimesFallen = 'HKQuantityTypeIdentifierNumberOfTimesFallen',
214
+
215
+ /**
216
+ * Electrodermal Activity
217
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierelectrodermalactivity Apple Docs HKQuantityTypeIdentifierElectrodermalActivity}
218
+ */
219
+ electrodermalActivity = 'HKQuantityTypeIdentifierElectrodermalActivity',
220
+
221
+ /**
222
+ * Inhaler Usage
223
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierinhalerusage Apple Docs HKQuantityTypeIdentifierInhalerUsage}
224
+ * @since iOS 8
225
+ */
226
+ inhalerUsage = 'HKQuantityTypeIdentifierInhalerUsage',
227
+
228
+ /**
229
+ * Insulin Delivery
230
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierinsulindelivery Apple Docs HKQuantityTypeIdentifierInsulinDelivery}
231
+ * @since iOS 11
232
+ */
233
+ insulinDelivery = 'HKQuantityTypeIdentifierInsulinDelivery',
234
+
235
+ /**
236
+ * Blood Alcohol Content
237
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierbloodalcoholcontent Apple Docs HKQuantityTypeIdentifierBloodAlcoholContent}
238
+ * @since iOS 8
239
+ */
240
+ bloodAlcoholContent = 'HKQuantityTypeIdentifierBloodAlcoholContent',
241
+
242
+ /**
243
+ * Forced Vital Capacity
244
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierforcedvitalcapacity Apple Docs HKQuantityTypeIdentifierForcedVitalCapacity}
245
+ */
246
+ forcedVitalCapacity = 'HKQuantityTypeIdentifierForcedVitalCapacity',
247
+
248
+ /**
249
+ * Forced Expiratory Volume1
250
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierforcedexpiratoryvolume1 Apple Docs HKQuantityTypeIdentifierForcedExpiratoryVolume1}
251
+ * @since iOS 8
252
+ */
253
+ forcedExpiratoryVolume1 = 'HKQuantityTypeIdentifierForcedExpiratoryVolume1',
254
+
255
+ /**
256
+ * Peak Expiratory Flow Rate
257
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierpeakexpiratoryflowrate Apple Docs HKQuantityTypeIdentifierPeakExpiratoryFlowRate}
258
+ * @since iOS 8
259
+ */
260
+ peakExpiratoryFlowRate = 'HKQuantityTypeIdentifierPeakExpiratoryFlowRate',
261
+
262
+ /**
263
+ * Environmental Audio Exposure
264
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierenvironmentalaudioexposure Apple Docs HKQuantityTypeIdentifierEnvironmentalAudioExposure}
265
+ * @since iOS 13
266
+ */
267
+ environmentalAudioExposure = 'HKQuantityTypeIdentifierEnvironmentalAudioExposure',
268
+
269
+ /**
270
+ * Headphone Audio Exposure
271
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierheadphoneaudioexposure Apple Docs HKQuantityTypeIdentifierHeadphoneAudioExposure}
272
+ * @since iOS 13
273
+ */
274
+ headphoneAudioExposure = 'HKQuantityTypeIdentifierHeadphoneAudioExposure', // Pressure, Cumulative
275
+
74
276
  // Nutrition
75
- dietaryFatTotal = 'HKQuantityTypeIdentifierDietaryFatTotal', // Mass, Cumulative
76
- dietaryFatPolyunsaturated = 'HKQuantityTypeIdentifierDietaryFatPolyunsaturated', // Mass, Cumulative
77
- dietaryFatMonounsaturated = 'HKQuantityTypeIdentifierDietaryFatMonounsaturated', // Mass, Cumulative
78
- dietaryFatSaturated = 'HKQuantityTypeIdentifierDietaryFatSaturated', // Mass, Cumulative
79
- dietaryCholesterol = 'HKQuantityTypeIdentifierDietaryCholesterol', // Mass, Cumulative
80
- dietarySodium = 'HKQuantityTypeIdentifierDietarySodium', // Mass, Cumulative
81
- dietaryCarbohydrates = 'HKQuantityTypeIdentifierDietaryCarbohydrates', // Mass, Cumulative
82
- dietaryFiber = 'HKQuantityTypeIdentifierDietaryFiber', // Mass, Cumulative
83
- dietarySugar = 'HKQuantityTypeIdentifierDietarySugar', // Mass, Cumulative
277
+ /**
278
+ * Dietary Fat Total
279
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierdietaryfattotal Apple Docs HKQuantityTypeIdentifierDietaryFatTotal}
280
+ * @since iOS 8
281
+ */
282
+ dietaryFatTotal = 'HKQuantityTypeIdentifierDietaryFatTotal', // Mass, Cumulative
283
+
284
+ /**
285
+ * Dietary Fat Polyunsaturated
286
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierdietaryfatpolyunsaturated Apple Docs HKQuantityTypeIdentifierDietaryFatPolyunsaturated}
287
+ */
288
+ dietaryFatPolyunsaturated = 'HKQuantityTypeIdentifierDietaryFatPolyunsaturated', // Mass, Cumulative
289
+
290
+ /**
291
+ * Dietary Fat Monounsaturated
292
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierdietaryfatmonounsaturated Apple Docs HKQuantityTypeIdentifierDietaryFatMonounsaturated}
293
+ */
294
+ dietaryFatMonounsaturated = 'HKQuantityTypeIdentifierDietaryFatMonounsaturated', // Mass, Cumulative
295
+ /**
296
+ * Dietary Fat Saturated
297
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierdietaryfatsaturated Apple Docs HKQuantityTypeIdentifierDietaryFatSaturated}
298
+ */
299
+ dietaryFatSaturated = 'HKQuantityTypeIdentifierDietaryFatSaturated', // Mass, Cumulative
300
+
301
+ /**
302
+ * Dietary Cholesterol
303
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierdietarycholesterol Apple Docs HKQuantityTypeIdentifierDietaryCholesterol}
304
+ */
305
+ dietaryCholesterol = 'HKQuantityTypeIdentifierDietaryCholesterol', // Mass, Cumulative
306
+
307
+ /**
308
+ * Dietary Sodium
309
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierdietarysodium Apple Docs HKQuantityTypeIdentifierDietarySodium}
310
+ */
311
+ dietarySodium = 'HKQuantityTypeIdentifierDietarySodium', // Mass, Cumulative
312
+
313
+ /**
314
+ * Dietary Carbohydrates
315
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierdietarycarbohydrates Apple Docs HKQuantityTypeIdentifierDietaryCarbohydrates}
316
+ */
317
+ dietaryCarbohydrates = 'HKQuantityTypeIdentifierDietaryCarbohydrates', // Mass, Cumulative
318
+
319
+ /**
320
+ * Dietary Fiber
321
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierdietaryfiber Apple Docs HKQuantityTypeIdentifierDietaryFiber}
322
+ */
323
+ dietaryFiber = 'HKQuantityTypeIdentifierDietaryFiber', // Mass, Cumulative
324
+ /**
325
+ * Dietary Sugar
326
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierdietarysugar Apple Docs HKQuantityTypeIdentifierDietarySugar}
327
+ */
328
+ dietarySugar = 'HKQuantityTypeIdentifierDietarySugar', // Mass, Cumulative
329
+
330
+ /**
331
+ * Dietary Energy Consumed
332
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierdietaryenergyconsumed Apple Docs HKQuantityTypeIdentifierDietaryEnergyConsumed}
333
+ */
84
334
  dietaryEnergyConsumed = 'HKQuantityTypeIdentifierDietaryEnergyConsumed', // Energy, Cumulative
85
- dietaryProtein = 'HKQuantityTypeIdentifierDietaryProtein', // Mass, Cumulative
86
335
 
336
+ /**
337
+ * Dietary Protein
338
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierdietaryprotein Apple Docs HKQuantityTypeIdentifierDietaryProtein}
339
+ */
340
+ dietaryProtein = 'HKQuantityTypeIdentifierDietaryProtein', // Mass, Cumulative
341
+
342
+ /**
343
+ * Dietary Vitamin A
344
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierdietaryvitamina Apple Docs HKQuantityTypeIdentifierDietaryVitaminA}
345
+ */
87
346
  dietaryVitaminA = 'HKQuantityTypeIdentifierDietaryVitaminA', // Mass, Cumulative
347
+
348
+ /**
349
+ * Dietary Vitamin B6
350
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierdietaryvitaminb6 Apple Docs HKQuantityTypeIdentifierDietaryVitaminB6}
351
+ */
88
352
  dietaryVitaminB6 = 'HKQuantityTypeIdentifierDietaryVitaminB6', // Mass, Cumulative
353
+
354
+ /**
355
+ * Dietary Vitamin B12
356
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierdietaryvitaminb12 Apple Docs HKQuantityTypeIdentifierDietaryVitaminB12}
357
+ */
89
358
  dietaryVitaminB12 = 'HKQuantityTypeIdentifierDietaryVitaminB12', // Mass, Cumulative
359
+
360
+ /**
361
+ * Dietary Vitamin C
362
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierdietaryvitaminc Apple Docs HKQuantityTypeIdentifierDietaryVitaminC}
363
+ */
90
364
  dietaryVitaminC = 'HKQuantityTypeIdentifierDietaryVitaminC', // Mass, Cumulative
365
+
366
+ /**
367
+ * Dietary Vitamin D
368
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierdietaryvitamind Apple Docs HKQuantityTypeIdentifierDietaryVitaminD}
369
+ */
91
370
  dietaryVitaminD = 'HKQuantityTypeIdentifierDietaryVitaminD', // Mass, Cumulative
371
+
372
+ /**
373
+ * Dietary Vitamin E
374
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierdietaryvitamine Apple Docs HKQuantityTypeIdentifierDietaryVitaminE}
375
+ */
92
376
  dietaryVitaminE = 'HKQuantityTypeIdentifierDietaryVitaminE', // Mass, Cumulative
377
+
378
+ /**
379
+ * Dietary Vitamin K
380
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierdietaryvitamink Apple Docs HKQuantityTypeIdentifierDietaryVitaminK}
381
+ */
93
382
  dietaryVitaminK = 'HKQuantityTypeIdentifierDietaryVitaminK', // Mass, Cumulative
383
+ /**
384
+ * Dietary Calcium
385
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierdietarycalcium Apple Docs HKQuantityTypeIdentifierDietaryCalcium}
386
+ */
94
387
  dietaryCalcium = 'HKQuantityTypeIdentifierDietaryCalcium', // Mass, Cumulative
388
+
389
+ /**
390
+ * Dietary Iron
391
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierdietaryiron Apple Docs HKQuantityTypeIdentifierDietaryIron}
392
+ */
95
393
  dietaryIron = 'HKQuantityTypeIdentifierDietaryIron', // Mass, Cumulative
394
+
395
+ /**
396
+ * Dietary Thiamin
397
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierdietarythiamin Apple Docs HKQuantityTypeIdentifierDietaryThiamin}
398
+ */
96
399
  dietaryThiamin = 'HKQuantityTypeIdentifierDietaryThiamin', // Mass, Cumulative
400
+
401
+ /**
402
+ * Dietary Riboflavin
403
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierdietaryriboflavin Apple Docs HKQuantityTypeIdentifierDietaryRiboflavin}
404
+ */
97
405
  dietaryRiboflavin = 'HKQuantityTypeIdentifierDietaryRiboflavin', // Mass, Cumulative
406
+
407
+ /**
408
+ * Dietary Niacin
409
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierdietaryniacin Apple Docs HKQuantityTypeIdentifierDietaryNiacin}
410
+ */
98
411
  dietaryNiacin = 'HKQuantityTypeIdentifierDietaryNiacin', // Mass, Cumulative
412
+
413
+ /**
414
+ * Dietary Folate
415
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierdietaryfolate Apple Docs HKQuantityTypeIdentifierDietaryFolate}
416
+ */
99
417
  dietaryFolate = 'HKQuantityTypeIdentifierDietaryFolate', // Mass, Cumulative
418
+
419
+ /**
420
+ * Dietary Biotin
421
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierdietarybiotin Apple Docs HKQuantityTypeIdentifierDietaryBiotin}
422
+ */
100
423
  dietaryBiotin = 'HKQuantityTypeIdentifierDietaryBiotin', // Mass, Cumulative
424
+
425
+ /**
426
+ * Dietary Pantothenic Acid
427
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierdietarypantothenicacid Apple Docs HKQuantityTypeIdentifierDietaryPantothenicAcid}
428
+ */
101
429
  dietaryPantothenicAcid = 'HKQuantityTypeIdentifierDietaryPantothenicAcid', // Mass, Cumulative
430
+
431
+ /**
432
+ * Dietary Phosphorus
433
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierdietaryphosphorus Apple Docs HKQuantityTypeIdentifierDietaryPhosphorus}
434
+ */
102
435
  dietaryPhosphorus = 'HKQuantityTypeIdentifierDietaryPhosphorus', // Mass, Cumulative
436
+
437
+ /**
438
+ * Dietary Iodine
439
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierdietaryiodine Apple Docs HKQuantityTypeIdentifierDietaryIodine}
440
+ */
103
441
  dietaryIodine = 'HKQuantityTypeIdentifierDietaryIodine', // Mass, Cumulative
442
+ /**
443
+ * Dietary Magnesium
444
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierdietarymagnesium Apple Docs HKQuantityTypeIdentifierDietaryMagnesium}
445
+ */
104
446
  dietaryMagnesium = 'HKQuantityTypeIdentifierDietaryMagnesium', // Mass, Cumulative
447
+
448
+ /**
449
+ * Dietary Zinc
450
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierdietaryzinc Apple Docs HKQuantityTypeIdentifierDietaryZinc}
451
+ */
105
452
  dietaryZinc = 'HKQuantityTypeIdentifierDietaryZinc', // Mass, Cumulative
453
+
454
+ /**
455
+ * Dietary Selenium
456
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierdietaryselenium Apple Docs HKQuantityTypeIdentifierDietarySelenium}
457
+ */
106
458
  dietarySelenium = 'HKQuantityTypeIdentifierDietarySelenium', // Mass, Cumulative
459
+
460
+ /**
461
+ * Dietary Copper
462
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierdietarycopper Apple Docs HKQuantityTypeIdentifierDietaryCopper}
463
+ */
107
464
  dietaryCopper = 'HKQuantityTypeIdentifierDietaryCopper', // Mass, Cumulative
465
+
466
+ /**
467
+ * Dietary Manganese
468
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierdietarymanganese Apple Docs HKQuantityTypeIdentifierDietaryManganese}
469
+ */
108
470
  dietaryManganese = 'HKQuantityTypeIdentifierDietaryManganese', // Mass, Cumulative
471
+
472
+ /**
473
+ * Dietary Chromium
474
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierdietarychromium Apple Docs HKQuantityTypeIdentifierDietaryChromium}
475
+ */
109
476
  dietaryChromium = 'HKQuantityTypeIdentifierDietaryChromium', // Mass, Cumulative
477
+
478
+ /**
479
+ * Dietary Molybdenum
480
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierdietarymolybdenum Apple Docs HKQuantityTypeIdentifierDietaryMolybdenum}
481
+ */
110
482
  dietaryMolybdenum = 'HKQuantityTypeIdentifierDietaryMolybdenum', // Mass, Cumulative
483
+
484
+ /**
485
+ * Dietary Chloride
486
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierdietarychloride Apple Docs HKQuantityTypeIdentifierDietaryChloride}
487
+ * @since iOS 8
488
+ */
111
489
  dietaryChloride = 'HKQuantityTypeIdentifierDietaryChloride', // Mass, Cumulative
490
+
491
+ /**
492
+ * Dietary Potassium
493
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierdietarypotassium Apple Docs HKQuantityTypeIdentifierDietaryPotassium}
494
+ * @since iOS 8
495
+ */
112
496
  dietaryPotassium = 'HKQuantityTypeIdentifierDietaryPotassium', // Mass, Cumulative
497
+
498
+ /**
499
+ * Dietary Caffeine
500
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierdietarycaffeine Apple Docs HKQuantityTypeIdentifierDietaryCaffeine}
501
+ * @since iOS 8
502
+ */
113
503
  dietaryCaffeine = 'HKQuantityTypeIdentifierDietaryCaffeine', // Mass, Cumulative
504
+
505
+ /**
506
+ * Dietary Water
507
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierdietarywater Apple Docs HKQuantityTypeIdentifierDietaryWater}
508
+ * @since iOS 9
509
+ */
114
510
  dietaryWater = 'HKQuantityTypeIdentifierDietaryWater', // Volume, Cumulative
115
511
 
116
512
  // Mobility
513
+ /**
514
+ * Six Minute Walk Test Distance
515
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifiersixminutewalktestdistance Apple Docs HKQuantityTypeIdentifierSixMinuteWalkTestDistance}
516
+ * @since iOS 14
517
+ */
117
518
  sixMinuteWalkTestDistance = 'HKQuantityTypeIdentifierSixMinuteWalkTestDistance',
519
+
520
+ /**
521
+ * Walking Speed
522
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierwalkingspeed Apple Docs HKQuantityTypeIdentifierWalkingSpeed}
523
+ * @since iOS 14
524
+ */
118
525
  walkingSpeed = 'HKQuantityTypeIdentifierWalkingSpeed',
526
+
527
+ /**
528
+ * Walking Step Length
529
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierwalkingsteplength Apple Docs HKQuantityTypeIdentifierWalkingStepLength}
530
+ * @since iOS 14
531
+ */
119
532
  walkingStepLength = 'HKQuantityTypeIdentifierWalkingStepLength',
533
+
534
+ /**
535
+ * Walking Asymmetry Percentage
536
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierwalkingasymmetrypercentage Apple Docs HKQuantityTypeIdentifierWalkingAsymmetryPercentage}
537
+ * @since iOS 14
538
+ */
120
539
  walkingAsymmetryPercentage = 'HKQuantityTypeIdentifierWalkingAsymmetryPercentage',
540
+
541
+ /**
542
+ * Walking Double Support Percentage
543
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierwalkingdoublesupportpercentage Apple Docs HKQuantityTypeIdentifierWalkingDoubleSupportPercentage}
544
+ * @since iOS 14
545
+ */
121
546
  walkingDoubleSupportPercentage = 'HKQuantityTypeIdentifierWalkingDoubleSupportPercentage',
547
+
548
+ /**
549
+ * Stair Ascent Speed
550
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierstairascentspeed Apple Docs HKQuantityTypeIdentifierStairAscentSpeed}
551
+ * @since iOS 14
552
+ */
122
553
  stairAscentSpeed = 'HKQuantityTypeIdentifierStairAscentSpeed',
554
+
555
+ /**
556
+ * Stair Descent Speed
557
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierstairdescentspeed Apple Docs HKQuantityTypeIdentifierStairDescentSpeed}
558
+ * @since iOS 14
559
+ */
123
560
  stairDescentSpeed = 'HKQuantityTypeIdentifierStairDescentSpeed',
124
561
 
562
+ /**
563
+ * UV Exposure
564
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifieruvexposure Apple Docs HKQuantityTypeIdentifierUVExposure}
565
+ * @since iOS 9
566
+ */
125
567
  uvExposure = 'HKQuantityTypeIdentifierUVExposure', // Scalar (Count), Discrete
126
568
 
127
- appleMoveTime = 'HKQuantityTypeIdentifierAppleMoveTime', // Time, Cumulative
128
- appleWalkingSteadiness = 'HKQuantityTypeIdentifierAppleWalkingSteadiness', // Scalar(Percent, 0.0 - 1.0), Discrete
569
+ /**
570
+ * Apple Move Time
571
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierapplemovetime Apple Docs HKQuantityTypeIdentifierAppleMoveTime}
572
+ * @since iOS 14.5
573
+ */
574
+ appleMoveTime = 'HKQuantityTypeIdentifierAppleMoveTime', // Time, Cumulative
575
+
576
+ /**
577
+ * Apple Walking Steadiness
578
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierapplewalkingsteadiness Apple Docs HKQuantityTypeIdentifierAppleWalkingSteadiness}
579
+ * @since iOS 15
580
+ */
581
+ appleWalkingSteadiness = 'HKQuantityTypeIdentifierAppleWalkingSteadiness', // Scalar(Percent, 0.0 - 1.0), Discrete
129
582
 
130
- numberOfAlcoholicBeverages = 'HKQuantityTypeIdentifierNumberOfAlcoholicBeverages', // Scalar(Count), Cumulative
583
+ /**
584
+ * Number Of Alcoholic Beverages
585
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifiernumberofalcoholicbeverages Apple Docs HKQuantityTypeIdentifierNumberOfAlcoholicBeverages}
586
+ * @since iOS 15
587
+ */
588
+ numberOfAlcoholicBeverages = 'HKQuantityTypeIdentifierNumberOfAlcoholicBeverages', // Scalar(Count), Cumulative
131
589
 
132
- atrialFibrillationBurden = 'HKQuantityTypeIdentifierAtrialFibrillationBurden', // Scalar(Percent, 0.0 - 1.0), Discrete
590
+ /**
591
+ * Atrial Fibrillation Burden
592
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifieratrialfibrillationburden Apple Docs HKQuantityTypeIdentifierAtrialFibrillationBurden}
593
+ * @since iOS 16
594
+ */
595
+ atrialFibrillationBurden = 'HKQuantityTypeIdentifierAtrialFibrillationBurden', // Scalar(Percent, 0.0 - 1.0), Discrete
133
596
 
597
+ /**
598
+ * Underwater Depth
599
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierunderwaterdepth Apple Docs HKQuantityTypeIdentifierUnderwaterDepth}
600
+ * @since iOS 16
601
+ */
134
602
  underwaterDepth = 'HKQuantityTypeIdentifierUnderwaterDepth', // Length, Discrete
135
603
 
604
+ /**
605
+ * Water Temperature
606
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierwatertemperature Apple Docs HKQuantityTypeIdentifierWaterTemperature}
607
+ * @since iOS 16
608
+ */
136
609
  waterTemperature = 'HKQuantityTypeIdentifierWaterTemperature', // Temperature, Discrete
137
610
 
611
+ /**
612
+ * Apple Sleeping Wrist Temperature
613
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierapplesleepingwristtemperature Apple Docs HKQuantityTypeIdentifierAppleSleepingWristTemperature}
614
+ * @since iOS 17
615
+ */
138
616
  appleSleepingWristTemperature = 'HKQuantityTypeIdentifierAppleSleepingWristTemperature', // Temperature, Discrete
139
617
 
140
- timeInDaylight = 'HKQuantityTypeIdentifierTimeInDaylight',
618
+ /**
619
+ * Time In Daylight
620
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifiertimeindaylight Apple Docs HKQuantityTypeIdentifierTimeInDaylight}
621
+ * @since iOS 17
622
+ */
623
+ timeInDaylight = 'HKQuantityTypeIdentifierTimeInDaylight', // Time, Cumulative
141
624
 
142
- physicalEffort = 'HKQuantityTypeIdentifierPhysicalEffort',
625
+ /**
626
+ * Physical Effort
627
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierphysicaleffort Apple Docs HKQuantityTypeIdentifierPhysicalEffort}
628
+ * @since iOS 17
629
+ */
630
+ physicalEffort = 'HKQuantityTypeIdentifierPhysicalEffort', // Scalar (Percent, 0.0 - 1.0), Discrete
143
631
 
632
+ /**
633
+ * Cycling Speed
634
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifiercyclingspeed Apple Docs HKQuantityTypeIdentifierCyclingSpeed}
635
+ * @since iOS 17
636
+ */
144
637
  cyclingSpeed = 'HKQuantityTypeIdentifierCyclingSpeed',
145
638
 
639
+ /**
640
+ * Cycling Power
641
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifiercyclingpower Apple Docs HKQuantityTypeIdentifierCyclingPower}
642
+ * @since iOS 17
643
+ */
146
644
  cyclingPower = 'HKQuantityTypeIdentifierCyclingPower',
147
645
 
646
+ /**
647
+ * Cycling Functional Threshold Power
648
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifiercyclingfunctionalthresholdpower Apple Docs HKQuantityTypeIdentifierCyclingFunctionalThresholdPower}
649
+ * @since iOS 17
650
+ */
148
651
  cyclingFunctionalThresholdPower = 'HKQuantityTypeIdentifierCyclingFunctionalThresholdPower',
149
652
 
653
+ /**
654
+ * Cycling Cadence
655
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifiercyclingcadence Apple Docs HKQuantityTypeIdentifierCyclingCadence}
656
+ * @since iOS 17
657
+ */
150
658
  cyclingCadence = 'HKQuantityTypeIdentifierCyclingCadence',
151
659
 
660
+ /**
661
+ * Environmental Sound Reduction
662
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierenvironmentalsoundreduction Apple Docs HKQuantityTypeIdentifierEnvironmentalSoundReduction}
663
+ * @since iOS 16
664
+ */
152
665
  environmentalSoundReduction = 'HKQuantityTypeIdentifierEnvironmentalSoundReduction',
153
666
 
667
+ /**
668
+ * Heart Rate Recovery One Minute
669
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierheartraterecoveryoneminute Apple Docs HKQuantityTypeIdentifierHeartRateRecoveryOneMinute}
670
+ * @since iOS 16
671
+ */
154
672
  heartRateRecoveryOneMinute = 'HKQuantityTypeIdentifierHeartRateRecoveryOneMinute',
155
673
  }
156
674
 
@@ -169,7 +687,7 @@ export enum HKHeartRateMotionContext {
169
687
  }
170
688
 
171
689
  /**
172
- * See https://developer.apple.com/documentation/healthkit/hkcorrelationtypeidentifier
690
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkcorrelationtypeidentifier Apple Docs }
173
691
  */
174
692
  export enum HKCorrelationTypeIdentifier {
175
693
  bloodPressure = 'HKCorrelationTypeIdentifierBloodPressure',
@@ -177,7 +695,7 @@ export enum HKCorrelationTypeIdentifier {
177
695
  }
178
696
 
179
697
  /**
180
- * See https://developer.apple.com/documentation/healthkit/hkcategorytypeidentifier
698
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkcategorytypeidentifier Apple Docs }
181
699
  */
182
700
  export enum HKCategoryTypeIdentifier {
183
701
  sleepAnalysis = 'HKCategoryTypeIdentifierSleepAnalysis',
@@ -425,7 +943,7 @@ export interface HKWorkoutMetadata
425
943
  }
426
944
 
427
945
  /**
428
- * See https://developer.apple.com/documentation/healthkit/hkauthorizationrequeststatus
946
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkauthorizationrequeststatus Apple Docs }
429
947
  */
430
948
  export enum HKAuthorizationRequestStatus {
431
949
  unknown = 0,
@@ -434,7 +952,7 @@ export enum HKAuthorizationRequestStatus {
434
952
  }
435
953
 
436
954
  /**
437
- * See https://developer.apple.com/documentation/healthkit/hkauthorizationstatus
955
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkauthorizationstatus Apple Docs }
438
956
  */
439
957
  export enum HKAuthorizationStatus {
440
958
  notDetermined = 0,
@@ -451,7 +969,7 @@ export type HKQuantity<
451
969
  };
452
970
 
453
971
  /**
454
- * See https://developer.apple.com/documentation/healthkit/hkbloodtype
972
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkbloodtype Apple Docs }
455
973
  */
456
974
  export enum HKBloodType {
457
975
  notSet = 0,
@@ -466,7 +984,7 @@ export enum HKBloodType {
466
984
  }
467
985
 
468
986
  /**
469
- * See https://developer.apple.com/documentation/healthkit/hkbiologicalsex
987
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkbiologicalsex Apple Docs }
470
988
  */
471
989
  export enum HKBiologicalSex {
472
990
  notSet = 0,
@@ -476,7 +994,7 @@ export enum HKBiologicalSex {
476
994
  }
477
995
 
478
996
  /**
479
- * See https://developer.apple.com/documentation/healthkit/hkfitzpatrickskintype
997
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkfitzpatrickskintype Apple Docs }
480
998
  */
481
999
  export enum HKFitzpatrickSkinType {
482
1000
  notSet = 0,
@@ -489,7 +1007,7 @@ export enum HKFitzpatrickSkinType {
489
1007
  }
490
1008
 
491
1009
  /**
492
- * See https://developer.apple.com/documentation/healthkit/hkstatisticsoptions
1010
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkstatisticsoptions Apple Docs }
493
1011
  */
494
1012
  export enum HKStatisticsOptions {
495
1013
  cumulativeSum = 'cumulativeSum',
@@ -519,7 +1037,7 @@ export type QueryStatisticsResponseRaw<
519
1037
  };
520
1038
 
521
1039
  /**
522
- * https://developer.apple.com/documentation/healthkit/hkcategoryvaluecervicalmucusquality
1040
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkcategoryvaluecervicalmucusquality Apple Docs }
523
1041
  */
524
1042
  export enum HKCategoryValueCervicalMucusQuality {
525
1043
  dry = 1,
@@ -530,7 +1048,7 @@ export enum HKCategoryValueCervicalMucusQuality {
530
1048
  }
531
1049
 
532
1050
  /**
533
- * See https://developer.apple.com/documentation/healthkit/hkcategoryvaluemenstrualflow
1051
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkcategoryvaluemenstrualflow Apple Docs }
534
1052
  */
535
1053
  export enum HKCategoryValueMenstrualFlow {
536
1054
  unspecified = 1,
@@ -541,7 +1059,7 @@ export enum HKCategoryValueMenstrualFlow {
541
1059
  }
542
1060
 
543
1061
  /**
544
- * See https://developer.apple.com/documentation/healthkit/hkcategoryvalueovulationtestresult
1062
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkcategoryvalueovulationtestresult Apple Docs }
545
1063
  */
546
1064
  export enum HKCategoryValueOvulationTestResult {
547
1065
  negative = 1,
@@ -551,7 +1069,7 @@ export enum HKCategoryValueOvulationTestResult {
551
1069
  }
552
1070
 
553
1071
  /**
554
- * See https://developer.apple.com/documentation/healthkit/hkcategoryvaluesleepanalysis
1072
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkcategoryvaluesleepanalysis Apple Docs }
555
1073
  */
556
1074
  export enum HKCategoryValueSleepAnalysis {
557
1075
  inBed = 0,
@@ -563,7 +1081,7 @@ export enum HKCategoryValueSleepAnalysis {
563
1081
  }
564
1082
 
565
1083
  /**
566
- * https://developer.apple.com/documentation/healthkit/hkcategoryvalueappetitechanges
1084
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkcategoryvalueappetitechanges
567
1085
  */
568
1086
  export enum HKCategoryValueAppetiteChanges {
569
1087
  decreased = 2,
@@ -573,7 +1091,7 @@ export enum HKCategoryValueAppetiteChanges {
573
1091
  }
574
1092
 
575
1093
  /**
576
- * https://developer.apple.com/documentation/healthkit/hkcategoryvaluepresence
1094
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkcategoryvaluepresence
577
1095
  */
578
1096
  export enum HKCategoryValuePresence {
579
1097
  notPresent = 1,
@@ -581,7 +1099,7 @@ export enum HKCategoryValuePresence {
581
1099
  }
582
1100
 
583
1101
  /**
584
- * See https://developer.apple.com/documentation/healthkit/hkcategoryvalueseverity
1102
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkcategoryvalueseverity Apple Docs }
585
1103
  */
586
1104
  export enum HKCategoryValueSeverity {
587
1105
  notPresent = 1,
@@ -592,14 +1110,14 @@ export enum HKCategoryValueSeverity {
592
1110
  }
593
1111
 
594
1112
  /**
595
- * See https://developer.apple.com/documentation/healthkit/hkcategoryvalue/notapplicable
1113
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkcategoryvalue/notapplicable Apple Docs }
596
1114
  */
597
1115
  export enum HKCategoryValueNotApplicable {
598
1116
  notApplicable = 0,
599
1117
  }
600
1118
 
601
1119
  /**
602
- * See https://developer.apple.com/documentation/healthkit/hkcategoryvalue
1120
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkcategoryvalue Apple Docs }
603
1121
  */
604
1122
  export type HKCategoryValue =
605
1123
  | HKCategoryValueAppetiteChanges
@@ -613,7 +1131,7 @@ export type HKCategoryValue =
613
1131
  | number;
614
1132
 
615
1133
  /**
616
- * See https://developer.apple.com/documentation/healthkit/hkinsulindeliveryreason
1134
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkinsulindeliveryreason Apple Docs }
617
1135
  */
618
1136
  export enum HKInsulinDeliveryReason {
619
1137
  basal = 1,
@@ -811,7 +1329,7 @@ export type HKCategoryValueForIdentifier<T extends HKCategoryTypeIdentifier> =
811
1329
  : number;
812
1330
 
813
1331
  /**
814
- * See https://developer.apple.com/documentation/healthkit/hkcategoryvaluepregnancytestresult
1332
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkcategoryvaluepregnancytestresult Apple Docs }
815
1333
  */
816
1334
  enum HKCategoryValuePregnancyTestResult {
817
1335
  positive = 2,
@@ -1076,7 +1594,7 @@ export type HKUnit =
1076
1594
  | `${VolumeUnit}`;
1077
1595
 
1078
1596
  /**
1079
- * See https://developer.apple.com/documentation/healthkit/hkdevice
1597
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkdevice Apple Docs }
1080
1598
  */
1081
1599
  export type HKDevice = {
1082
1600
  readonly name: string; // ex: "Apple Watch"
@@ -1090,7 +1608,7 @@ export type HKDevice = {
1090
1608
  };
1091
1609
 
1092
1610
  /**
1093
- * See https://developer.apple.com/documentation/healthkit/hkobject/1615781-source
1611
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkobject/1615781-source Apple Docs }
1094
1612
  */
1095
1613
  export type HKSource = {
1096
1614
  readonly name: string;
@@ -1098,7 +1616,7 @@ export type HKSource = {
1098
1616
  };
1099
1617
 
1100
1618
  /**
1101
- * See https://developer.apple.com/documentation/healthkit/hkobject/1615483-sourcerevision
1619
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkobject/1615483-sourcerevision Apple Docs }
1102
1620
  */
1103
1621
  export type HKSourceRevision = {
1104
1622
  readonly source: HKSource;
@@ -1108,7 +1626,7 @@ export type HKSourceRevision = {
1108
1626
  };
1109
1627
 
1110
1628
  /**
1111
- * See https://developer.apple.com/documentation/healthkit/hkquantitysample
1629
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitysample Apple Docs }
1112
1630
  */
1113
1631
  export type HKQuantitySampleRaw<
1114
1632
  TQuantityIdentifier extends HKQuantityTypeIdentifier = HKQuantityTypeIdentifier,
@@ -1260,7 +1778,9 @@ export type HKCorrelationRaw<TIdentifier extends HKCorrelationTypeIdentifier> =
1260
1778
 
1261
1779
  type QueryId = string;
1262
1780
 
1263
- /** See https://developer.apple.com/documentation/healthkit/hkupdatefrequency */
1781
+ /**
1782
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkupdatefrequency Apple Docs }
1783
+ */
1264
1784
  export enum HKUpdateFrequency {
1265
1785
  immediate = 1,
1266
1786
  hourly = 2,
@@ -1287,25 +1807,33 @@ export type WorkoutRoute = {
1287
1807
  };
1288
1808
 
1289
1809
  type ReactNativeHealthkitTypeNative = {
1290
- /** See https://developer.apple.com/documentation/healthkit/hkhealthstore/1614180-ishealthdataavailable */
1810
+ /**
1811
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkhealthstore/1614180-ishealthdataavailable Apple Docs }
1812
+ */
1291
1813
  isHealthDataAvailable(): Promise<boolean>;
1814
+ // Todo [>8]: Rename to align with Apple function name (isProtectedDataAvailable) - remember to rename native code :)
1292
1815
  canAccessProtectedData(): Promise<boolean>;
1293
1816
  getBloodType(): Promise<HKBloodType>;
1294
1817
  getDateOfBirth(): Promise<string>;
1295
1818
  getBiologicalSex(): Promise<HKBiologicalSex>;
1296
1819
  getFitzpatrickSkinType(): Promise<HKFitzpatrickSkinType>;
1297
1820
  readonly getWheelchairUse: () => Promise<HKWheelchairUse>;
1298
-
1299
- /** See https://developer.apple.com/documentation/healthkit/hkhealthstore/1614175-enablebackgrounddelivery */
1821
+ /**
1822
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkhealthstore/1614175-enablebackgrounddelivery Apple Docs }
1823
+ */
1300
1824
  readonly enableBackgroundDelivery: (
1301
1825
  typeIdentifier: HKSampleTypeIdentifier,
1302
1826
  updateFrequency: HKUpdateFrequency
1303
1827
  ) => Promise<boolean>;
1304
- /** https://developer.apple.com/documentation/healthkit/hkhealthstore/1614177-disablebackgrounddelivery */
1828
+ /**
1829
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkhealthstore/1614177-disablebackgrounddelivery Apple Docs }
1830
+ */
1305
1831
  readonly disableBackgroundDelivery: (
1306
1832
  typeIdentifier: HKSampleTypeIdentifier
1307
1833
  ) => Promise<boolean>;
1308
- /** See https://developer.apple.com/documentation/healthkit/hkhealthstore/1614158-disableallbackgrounddelivery */
1834
+ /**
1835
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkhealthstore/1614158-disableallbackgrounddelivery Apple Docs }
1836
+ */
1309
1837
  readonly disableAllBackgroundDelivery: () => Promise<boolean>;
1310
1838
 
1311
1839
  readonly saveCorrelationSample: <
@@ -1342,14 +1870,20 @@ type ReactNativeHealthkitTypeNative = {
1342
1870
  identifier: HKSampleTypeIdentifier
1343
1871
  ): Promise<QueryId>;
1344
1872
  unsubscribeQuery(queryId: QueryId): Promise<boolean>;
1345
- /** See https://developer.apple.com/documentation/healthkit/hkhealthstore/1614154-authorizationstatus */
1873
+ /**
1874
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkhealthstore/1614154-authorizationstatus Apple Docs }
1875
+ */
1346
1876
  authorizationStatusFor(type: HealthkitReadAuthorization): Promise<HKAuthorizationStatus>;
1347
- /** See https://developer.apple.com/documentation/healthkit/hkhealthstore/2994346-getrequeststatusforauthorization */
1877
+ /**
1878
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkhealthstore/2994346-getrequeststatusforauthorization Apple Docs }
1879
+ */
1348
1880
  getRequestStatusForAuthorization(
1349
1881
  write: WritePermissions,
1350
1882
  read: ReadPermissions
1351
1883
  ): Promise<HKAuthorizationRequestStatus>;
1352
- /** See https://developer.apple.com/documentation/healthkit/hkhealthstore/1614152-requestauthorization */
1884
+ /**
1885
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkhealthstore/1614152-requestauthorization Apple Docs }
1886
+ */
1353
1887
  requestAuthorization(
1354
1888
  write: WritePermissions,
1355
1889
  read: ReadPermissions