From 2d3897f7b6ee0445171996f2d9a33eb856a46561 Mon Sep 17 00:00:00 2001 From: Andrew Allen Date: Mon, 29 Apr 2019 16:57:06 -0700 Subject: [PATCH] add docs for getBodyFatPercentageSamples and getLeanBodyMassSamples --- README.md | 2 ++ docs/getBodyFatPercentageSamples().md | 27 ++++++++++++++++++++++++++ docs/getLeanBodyMassSamples().md | 28 +++++++++++++++++++++++++++ 3 files changed, 57 insertions(+) create mode 100644 docs/getBodyFatPercentageSamples().md create mode 100644 docs/getLeanBodyMassSamples().md diff --git a/README.md b/README.md index ed8ae18..9fd77ed 100644 --- a/README.md +++ b/README.md @@ -128,8 +128,10 @@ AppleHealthKit.initHealthKit(options: Object, (err: string, results: Object) => * [getHeightSamples](/docs/getHeightSamples().md) * [getLatestBmi](/docs/getLatestBmi().md) * [getLatestBodyFatPercentage](/docs/getLatestBodyFatPercentage().md) + * [getBodyFatPercentageSamples](/docs/getBodyFatPercentageSamples().md) * [getLatestHeight](/docs/getLatestHeight().md) * [getLatestLeanBodyMass](/docs/getLatestLeanBodyMass().md) + * [getLeanBodyMassSamples](/docs/getLeanBodyMassSamples().md) * [getLatestWeight](/docs/getLatestWeight().md) * [getRespiratoryRateSamples](/docs/getRespiratoryRateSamples().md) * [getSleepSamples](/docs/getSleepSamples().md) diff --git a/docs/getBodyFatPercentageSamples().md b/docs/getBodyFatPercentageSamples().md new file mode 100644 index 0000000..8e3e872 --- /dev/null +++ b/docs/getBodyFatPercentageSamples().md @@ -0,0 +1,27 @@ +Query for body fat percentage samples. the options object is used to setup a query to retrieve relevant samples. + +```javascript +let options = { + startDate: (new Date(2016,4,27)).toISOString(), // required + endDate: (new Date()).toISOString(), // optional; default now + ascending: false, // optional; default false + limit:10, // optional; default no limit +}; +``` + +```javascript +AppleHealthKit.getBodyFatPercentageSamples(options, (err: Object, results: Array) => { + if (err) { + return; + } + console.log(results) +}); +``` + +```javascript +[ + { value: 16.5, startDate: '2016-07-09T00:00:00.000-0400', endDate: '2016-07-10T00:00:00.000-0400' }, + { value: 16.1, startDate: '2016-07-08T00:00:00.000-0400', endDate: '2016-07-09T00:00:00.000-0400' }, + { value: 15.9, startDate: '2016-07-07T00:00:00.000-0400', endDate: '2016-07-08T00:00:00.000-0400' }, +] +``` diff --git a/docs/getLeanBodyMassSamples().md b/docs/getLeanBodyMassSamples().md new file mode 100644 index 0000000..93a0af8 --- /dev/null +++ b/docs/getLeanBodyMassSamples().md @@ -0,0 +1,28 @@ +Query for lean body mass samples. the options object is used to setup a query to retrieve relevant samples. + +```javascript +let options = { + unit: 'pound', // optional; default 'pound' + startDate: (new Date(2016,4,27)).toISOString(), // required + endDate: (new Date()).toISOString(), // optional; default now + ascending: false, // optional; default false + limit:10, // optional; default no limit +}; +``` + +```javascript +AppleHealthKit.getLeanBodyMassSamples(options, (err: Object, results: Array) => { + if (err) { + return; + } + console.log(results) +}); +``` + +```javascript +[ + { value: 160, startDate: '2016-07-09T00:00:00.000-0400', endDate: '2016-07-10T00:00:00.000-0400' }, + { value: 161, startDate: '2016-07-08T00:00:00.000-0400', endDate: '2016-07-09T00:00:00.000-0400' }, + { value: 165, startDate: '2016-07-07T00:00:00.000-0400', endDate: '2016-07-08T00:00:00.000-0400' }, +] +``` -- 2.26.2