Skip to content

Get Energy Doc Fixes #304

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 3, 2023
Merged

Get Energy Doc Fixes #304

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3d0fe4a
docs fix
Mar 27, 2023
0913ec1
text improvement
Mar 27, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion docs/getActiveEnergyBurned.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,15 @@
# getActiveEnergyBurned

A quantity sample type that measures the amount of active energy the user has burned.
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:

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

Expand Down
5 changes: 4 additions & 1 deletion docs/getBasalEnergyBurned.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,16 @@
# getBasalEnergyBurned

A quantity sample type that measures the amount of energy burned.
A quantity sample type that measures the amount of `resting energy` burned within a period of time.
These samples together with `active energy` burned for the same time period represent the `total energy` burned for that period (usually seen as Total Kilocalories in a workout on Apple Watch).

Example input options:

```javascript
let options = {
startDate: new Date(2018, 10, 1).toISOString(), // required
endDate: new Date().toISOString(), // optional; default now
ascending: true, // optional
includeManuallyAdded: true, // optional
}
```

Expand Down