api.md

$ /Users/matas/Documents/projects/kilo/rn-fitness-tracker/node_modules/.bin/jsdoc2md --files ./dist/api/fitness.js ./dist/api/health.js ./dist/api/pedometer.js ./dist/types/dataTypes.js ./dist/types/fitnessTypes.js ./dist/utils/helpers.js ./dist/utils/mockData.js --separators

Modules

FitnessTrackerAPI

HealthTrackerAPI

PedometerAPI

FitnessTrackerAPI

• FitnessTrackerAPI
  • ~isTrackingAvailable() ⇒ Promise.<IFitnessTrackerStatus>
  • ~setupTracking(shouldTrackDistance) ⇒ Promise.<IFitnessTrackerStatus>
  • ~getStepsToday() ⇒ Promise.<number>
  • ~getStepsWeekTotal() ⇒ Promise.<Number>
  • ~getStepsDaily() ⇒ Promise.<IStepsDaily>
  • ~queryStepsTotalDaily(startDate, endDate) ⇒ Promise.<IStepsDaily>
  • ~getStepsData() ⇒ Promise.<IStepsData>
  • ~queryStepsTotal(startDate, endDate) ⇒ Promise.<Number>
  • ~getDistanceToday() ⇒ Promise.<number>
  • ~getDistanceWeekTotal() ⇒ Promise.<Number>
  • ~getDistanceDaily() ⇒ Promise.<IDistanceDaily>
  • ~getDistanceData() ⇒ Promise.<IDistanceData>
  • ~queryDistanceTotal(startDate, endDate) ⇒ Promise.<Number>

---

FitnessTrackerAPI~isTrackingAvailable() ⇒ Promise.<IFitnessTrackerStatus>

Returns if step tracking is authorized and available on both platforms

Kind: inner method of FitnessTrackerAPI

---

FitnessTrackerAPI~setupTracking(shouldTrackDistance) ⇒ Promise.<IFitnessTrackerStatus>

Sets up step tracking for walking & running steps and distance

Kind: inner method of FitnessTrackerAPI

Param	Type	Default	Description
shouldTrackDistance	boolean	false	if true, adds permission to track distance in Health consent screen

---

FitnessTrackerAPI~getStepsToday() ⇒ Promise.<number>

Returns number of steps today

Kind: inner method of FitnessTrackerAPI

---

FitnessTrackerAPI~getStepsWeekTotal() ⇒ Promise.<Number>

Returns number of steps this week

Kind: inner method of FitnessTrackerAPI

---

FitnessTrackerAPI~getStepsDaily() ⇒ Promise.<IStepsDaily>

Returns weekly steps object

Kind: inner method of FitnessTrackerAPI

---

FitnessTrackerAPI~queryStepsTotalDaily(startDate, endDate) ⇒ Promise.<IStepsDaily>

Returns daily totals of steps for specified time range

Kind: inner method of FitnessTrackerAPI

Param	Type
startDate	Date | number
endDate	Date | number

---

FitnessTrackerAPI~getStepsData() ⇒ Promise.<IStepsData>

Returns steps today and this week's steps object

Kind: inner method of FitnessTrackerAPI

---

FitnessTrackerAPI~queryStepsTotal(startDate, endDate) ⇒ Promise.<Number>

Returns number of steps for given time range

Kind: inner method of FitnessTrackerAPI

Param	Type
startDate	Date | number
endDate	Date | number

---

FitnessTrackerAPI~getDistanceToday() ⇒ Promise.<number>

Returns walking and running distance today in meters

Kind: inner method of FitnessTrackerAPI
Returns: Promise.<number> - number of meters

---

FitnessTrackerAPI~getDistanceWeekTotal() ⇒ Promise.<Number>

Returns walking and running distance this week in meters

Kind: inner method of FitnessTrackerAPI
Returns: Promise.<Number> - number of meters

---

FitnessTrackerAPI~getDistanceDaily() ⇒ Promise.<IDistanceDaily>

Returns daily distance object

Kind: inner method of FitnessTrackerAPI

---

FitnessTrackerAPI~getDistanceData() ⇒ Promise.<IDistanceData>

Returns distance today and this week's distance daily data object

Kind: inner method of FitnessTrackerAPI

---

FitnessTrackerAPI~queryDistanceTotal(startDate, endDate) ⇒ Promise.<Number>

Returns total distance in meters for given time range

Kind: inner method of FitnessTrackerAPI

Param	Type
startDate	Date | number
endDate	Date | number

---

HealthTrackerAPI

• HealthTrackerAPI
  • ~isTrackingSupportedIOS() ⇒ Promise.<boolean>
  • ~setupTrackingIOS(shareTypes, readTypes) ⇒ Promise.<boolean>
  • ~writeDataIOS(object) ⇒ Promise.<boolean>
  • ~writeDataArrayIOS(dataArray) ⇒ Promise.<boolean>
  • ~getAbsoluteTotalForTodayIOS(key, unit) ⇒ Promise.<number>
  • ~getStatisticTotalForTodayIOS(key, unit) ⇒ Promise.<number>
  • ~getStatisticTotalForWeekIOS(key, unit) ⇒ Promise.<number>
  • ~getStatisticWeekDailyIOS(key, unit) ⇒ Promise.<object>
  • ~queryDataRecordsIOS(key, unit, numberOfDays) ⇒ Promise.<number>
  • ~queryWorkoutsIOS() ⇒ Promise.<IWorkoutQueryData>
  • ~queryDailyTotalsIOS() ⇒ Promise.<object>
  • ~queryTotalIOS() ⇒ Promise.<object>
  • ~recordWorkoutIOS(object) ⇒ Promise.<boolean>
  • ~recordBloodPressureIOS(object) ⇒ Promise.<boolean>
  • ~getAuthStatusForTypeIOS(dataType) ⇒ Promise.<number>
  • ~getReadStatusForTypeIOS(dataType, unit) ⇒ Promise.<number>
  • ~deleteRecordIOS() ⇒ Promise.<number>

---

HealthTrackerAPI~isTrackingSupportedIOS() ⇒ Promise.<boolean>

iOS only! returns health tracking is supported

Kind: inner method of HealthTrackerAPI

---

HealthTrackerAPI~setupTrackingIOS(shareTypes, readTypes) ⇒ Promise.<boolean>

iOS only! Sets up health tracking and returns status

Kind: inner method of HealthTrackerAPI

Param	Type	Description
shareTypes	Array.<HealthDataType>	e.g. [HealthDataTypes.Fiber]
readTypes	Array.<HealthDataType>	e.g. [HealthDataTypes.Fiber]

---

HealthTrackerAPI~writeDataIOS(object) ⇒ Promise.<boolean>

iOS only! Writes given health data to Health API

Kind: inner method of HealthTrackerAPI

Param	Type	Description
object	object
object.key	HealthDataTypes
object.unit	UnitKey
object.quantity	Number
object.metadata	object
object.customUnixTimestamp	number	optional unix timestamp for record date

---

HealthTrackerAPI~writeDataArrayIOS(dataArray) ⇒ Promise.<boolean>

iOS only! Writes given health data array to Health API

Kind: inner method of HealthTrackerAPI

Param	Type
dataArray	array
dataArray.object	object
dataArray.object.key	HealthDataTypes
dataArray.object.unit	UnitKey
dataArray.object.quantity	Number
dataArray.object.metadata	object

---

HealthTrackerAPI~getAbsoluteTotalForTodayIOS(key, unit) ⇒ Promise.<number>

iOS only! Gets absolute total for given health data type and unit for current day

Kind: inner method of HealthTrackerAPI

Param	Type	Description
key	HealthDataType	e.g. HealthDataTypes.Fiber
unit	UnitType	e.g. UnitTypes.grams

---

HealthTrackerAPI~getStatisticTotalForTodayIOS(key, unit) ⇒ Promise.<number>

iOS only! Gets statistic total for given health data type and unit for current day, same number as in health app

Kind: inner method of HealthTrackerAPI

Param	Type	Description
key	HealthDataType	e.g. HealthDataTypes.Fiber
unit	UnitType	e.g. UnitTypes.grams

---

HealthTrackerAPI~getStatisticTotalForWeekIOS(key, unit) ⇒ Promise.<number>

iOS only! Gets statistic total for given health data type and unit for current week, same number as in health app

Kind: inner method of HealthTrackerAPI

Param	Type	Description
key	HealthDataType	e.g. HealthDataTypes.Fiber
unit	UnitType	e.g. UnitTypes.grams

---

HealthTrackerAPI~getStatisticWeekDailyIOS(key, unit) ⇒ Promise.<object>

iOS only! Gets statistic daily total for given health data type and unit for current week, same number as in health app

Kind: inner method of HealthTrackerAPI

Param	Type	Description
key	HealthDataType	e.g. HealthDataTypes.Fiber
unit	UnitType	e.g. UnitTypes.grams

---

HealthTrackerAPI~queryDataRecordsIOS(key, unit, numberOfDays) ⇒ Promise.<number>

iOS only! Returns every record for specified data type and unit for specified number of days

Kind: inner method of HealthTrackerAPI

Param	Type	Description
key	HealthDataType	e.g. HealthDataTypes.Fiber
unit	UnitType	e.g. UnitTypes.grams
numberOfDays	number

---

HealthTrackerAPI~queryWorkoutsIOS() ⇒ Promise.<IWorkoutQueryData>

iOS only! Returns workouts array for specified timeframe, filters by workout type if specified

Kind: inner method of HealthTrackerAPI

Param	Type	Description
object.startDate	Date | number
object.endDate	Date | number
object.key	WorkoutTypes	e.g. WorkoutTypes.Running (Optional)

---

HealthTrackerAPI~queryDailyTotalsIOS() ⇒ Promise.<object>

iOS only! Returns daily totals for specified data type and unit for specified time frame

Kind: inner method of HealthTrackerAPI

Param	Type	Description
object.key	HealthDataType	e.g. HealthDataTypes.Fiber
object.unit	UnitType	e.g. UnitTypes.grams
object.startDate	Date | number
object.endDate	Date | number

---

HealthTrackerAPI~queryTotalIOS() ⇒ Promise.<object>

iOS only! Returns total for specified data type and unit for specified time frame

Kind: inner method of HealthTrackerAPI

Param	Type	Description
object.key	HealthDataType	e.g. HealthDataTypes.Fiber
object.unit	UnitType	e.g. UnitTypes.grams
object.startDate	Date | number
object.endDate	Date | number

---

HealthTrackerAPI~recordWorkoutIOS(object) ⇒ Promise.<boolean>

iOS only! Records given workout data to Health API

Kind: inner method of HealthTrackerAPI

Param	Type	Description
object	object
object.startDate	Date | number
object.endDate	Date | number
object.energyBurned	Number	number of calories in kcal (Optional)
object.totalDistance	number	total distance travelled (Optional)
object.metadata	object	(Optional)

---

HealthTrackerAPI~recordBloodPressureIOS(object) ⇒ Promise.<boolean>

iOS only! Records given blood pressure data to Health API

Kind: inner method of HealthTrackerAPI

Param	Type
object	object
object.systolicPressure	Number
object.diastolicPressure	Number
object.date	Date | number
object.metadata	object

---

HealthTrackerAPI~getAuthStatusForTypeIOS(dataType) ⇒ Promise.<number>

iOS only! Returns write (share) status for data type in Health API

Kind: inner method of HealthTrackerAPI
Returns: Promise.<number> - 0 - notDetermined, 1 - sharingDenied, 2 - sharingAuthorized

Param	Type	Description
dataType	HealthDataType	e.g. HealthDataTypes.Fiber

---

HealthTrackerAPI~getReadStatusForTypeIOS(dataType, unit) ⇒ Promise.<number>

iOS only! Returns read status for data type in Health API WARNING! This method is unofficial. Queries for data in time span of 2 years with limit of one, returns readDenied if no data is available.

Kind: inner method of HealthTrackerAPI
Returns: Promise.<number> - 0 - notDetermined, 1 - readDenied, 2 - readAuthorized

Param	Type	Description
dataType	HealthDataType	e.g. HealthDataTypes.Fiber
unit	HealthDataType	e.g. HealthDataTypes.Fiber

---

HealthTrackerAPI~deleteRecordIOS() ⇒ Promise.<number>

iOS only! Delete record from Health API

Kind: inner method of HealthTrackerAPI
Returns: Promise.<number> - 0 - notDetermined, 1 - readDenied, 2 - readAuthorized

Param	Type	Description
object.key	HealthDataType	e.g. HealthDataTypes.Fiber
object.uuid	number	optional unique healthkit record id
object.date	number	optional unix timestamp for record date

---

PedometerAPI

• PedometerAPI
  • ~isTrackingSupportedIOS() ⇒ Promise.<IFitnessTrackerAvailability>
  • ~isTrackingAvailable() ⇒ Promise.<IFitnessTrackerStatus>
  • ~setupTracking() ⇒ Promise.<IFitnessTrackerStatus>
  • ~getStepsToday() ⇒ Promise.<number>
  • ~getStepsWeekTotal() ⇒ Promise.<Number>
  • ~getStepsDaily() ⇒ Promise.<IWeekDailySteps>
  • ~getStepsData() ⇒ Promise.<IStepTrackerData>
  • ~getDistanceToday() ⇒ Promise.<number>
  • ~getDistanceWeekTotal() ⇒ Promise.<Number>
  • ~getDistanceDaily() ⇒ Promise.<IDistanceDaily>
  • ~getDistanceData() ⇒ Promise.<IDistanceData>
  • ~getFloorsTodayIOS() ⇒ Promise.<number>
  • ~getFloorsWeekTotalIOS() ⇒ Promise.<Number>
  • ~getFloorsDailyIOS() ⇒ Promise.<IFloorsDaily>
  • ~getFloorsDataIOS() ⇒ Promise.<IFloorsData>

---

PedometerAPI~isTrackingSupportedIOS() ⇒ Promise.<IFitnessTrackerAvailability>

iOS only! returns if step, distance and floor tracking is supported on device equals to 1 if supported or 0 if not.

Kind: inner method of PedometerAPI

---

PedometerAPI~isTrackingAvailable() ⇒ Promise.<IFitnessTrackerStatus>

Returns if step tracking is authorized and available on both platforms

Kind: inner method of PedometerAPI

---

PedometerAPI~setupTracking() ⇒ Promise.<IFitnessTrackerStatus>

Sets up step tracking and returns status not supported iOS devices also return trackingNotSupported: true param inside the status object

Kind: inner method of PedometerAPI

---

PedometerAPI~getStepsToday() ⇒ Promise.<number>

Returns number of steps today on iOS simulator returns mock data

Kind: inner method of PedometerAPI

---

PedometerAPI~getStepsWeekTotal() ⇒ Promise.<Number>

Returns number of steps this week on iOS simulator returns mock data

Kind: inner method of PedometerAPI

---

PedometerAPI~getStepsDaily() ⇒ Promise.<IWeekDailySteps>

Returns weekly steps object on iOS simulator returns mock data

Kind: inner method of PedometerAPI

---

PedometerAPI~getStepsData() ⇒ Promise.<IStepTrackerData>

Returns steps today and this week's steps object on iOS simulator returns mock data

Kind: inner method of PedometerAPI

---

PedometerAPI~getDistanceToday() ⇒ Promise.<number>

Returns walking and running distance today in meters on iOS simulator returns mock data

Kind: inner method of PedometerAPI
Returns: Promise.<number> - number of meters

---

PedometerAPI~getDistanceWeekTotal() ⇒ Promise.<Number>

Returns walking and running distance this week in meters on iOS simulator returns mock data

Kind: inner method of PedometerAPI
Returns: Promise.<Number> - number of meters

---

PedometerAPI~getDistanceDaily() ⇒ Promise.<IDistanceDaily>

Returns daily distance object on iOS simulator returns mock data

Kind: inner method of PedometerAPI

---

PedometerAPI~getDistanceData() ⇒ Promise.<IDistanceData>

Returns distance today and this week's distance object on iOS simulator returns mock data

Kind: inner method of PedometerAPI

---

PedometerAPI~getFloorsTodayIOS() ⇒ Promise.<number>

Returns walking and running distance today in meters on iOS simulator returns mock data

Kind: inner method of PedometerAPI
Returns: Promise.<number> - number of meters

---

PedometerAPI~getFloorsWeekTotalIOS() ⇒ Promise.<Number>

Returns walking and running distance this week in meters on iOS simulator returns mock data

Kind: inner method of PedometerAPI
Returns: Promise.<Number> - number of meters

---

PedometerAPI~getFloorsDailyIOS() ⇒ Promise.<IFloorsDaily>

Returns daily distance object on iOS simulator returns mock data

Kind: inner method of PedometerAPI

---

PedometerAPI~getFloorsDataIOS() ⇒ Promise.<IFloorsData>

Returns distance today and this week's distance object on iOS simulator returns mock data

Kind: inner method of PedometerAPI

---