Class default

This model implements the possibility of adding or retrieving HeartEvents that occurred on the Apple watch. Those Events can be HEART_OCCURRING_EVENTS For more information, see Chapter Vital Signs in https://developer.apple.com/documentation/healthkit/data_types

Hierarchy (view full)

Model
- default

Index

Constructors

Properties

onUpdated state channelId

Methods

addHeartEvent heartEvents heartEventsIterator init shutdown

Constructors

constructor

new default(channelManager): default
Parameters
- channelManager: default
  The channel manager instance
Returns default
Overrides Model.constructor
- Defined in models/HeartEventModel.ts:34

Properties

onUpdated

onUpdated: OEvent<((timeOfEarliestChange: Date) => void)> = ...

state

state: StateMachine<"Uninitialised" | "Initialised", "shutdown" | "init">

`Static` `Readonly`channelId

channelId: "heartEvent" = 'heartEvent'

Methods

addHeartEvent

addHeartEvent(heartEvent): Promise<void>
Adds a HeartEvent
Parameters
- heartEvent: HeartEvent
Returns Promise<void>
- Defined in models/HeartEventModel.ts:68

heartEvents

heartEvents(): Promise<ObjectData<HeartEvent>[]>
Get all the heartEvents

Returns Promise<ObjectData<HeartEvent>[]>
- Defined in models/HeartEventModel.ts:77

heartEventsIterator

heartEventsIterator(queryOptions?): AsyncIterableIterator<ObjectData<HeartEvent>>
returns iterator for Heart Events
Parameters
- OptionalqueryOptions: QueryOptions
Returns AsyncIterableIterator<ObjectData<HeartEvent>>
- Defined in models/HeartEventModel.ts:89

init

init(): Promise<void>
Initialize the model

Returns Promise<void>
- Defined in models/HeartEventModel.ts:43

shutdown

shutdown(): Promise<void>
Shutdown the model

Returns Promise<void>
Overrides Model.shutdown
- Defined in models/HeartEventModel.ts:55