Skip to content

Latest commit

 

History

History
40 lines (33 loc) · 861 Bytes

getActiveEnergyBurned.md

File metadata and controls

40 lines (33 loc) · 861 Bytes
Raw

getActiveEnergyBurned

A quantity sample type that measures the amount of active energy the user has burned within a period of time. This represents only the Active Kilocalories from the Total Kilocalories for that time period.

Example input options:

let options = {
  startDate: new Date(2021, 0, 0).toISOString(), // required
  endDate: new Date().toISOString(), // optional; default now
  ascending: true, // optional
  includeManuallyAdded: true, // optional
}

Call the method:

AppleHealthKit.getActiveEnergyBurned(
  (options: HealthInputOptions),
  (err: Object, results: HealthValue) => {
    if (err) {
      return
    }
    console.log(results)
  },
)

Example output:

[
  {
    "endDate": "2021-03-22T16:00:00.000-0300",
    "startDate": "2021-03-22T15:00:00.000-0300",
    "value": 123
  }
]