健康数量型数据（HealthQuantitySample） PRO#

HealthQuantitySample 表示一条健康数量类型的数据样本，例如一次心率测量、记录的步数或摄入的热量。它包含了关于该数据的类型、数值、时间区间、单位和可选的元数据信息。

该类是两个更具体子类的基类：

• HealthCumulativeQuantitySample（累计型样本）
• HealthDiscreteQuantitySample（离散型样本）

基本信息#

此类用于：

• 读取单条健康数据记录
• 写入新的健康数据记录
• 按单位转换样本数值

属性说明#

方法说明#

quantityValue(unit: HealthUnit): number#

以指定单位返回该样本的数值。

参数：

• unit: 单位对象（如 HealthUnit.kilocalorie()）

返回：

• 转换后的数值（number）

示例：

1const bpm = sample.quantityValue(HealthUnit.count().divided(HealthUnit.minute()))
2console.log(`心率: ${bpm} 次/分钟`)

静态方法#

HealthQuantitySample.create(options): HealthQuantitySample | null#

创建一条新的健康样本数据。

参数结构：

1{
2  type: HealthQuantityType
3  startDate: Date
4  endDate: Date
5  value: number
6  unit: HealthUnit
7  metadata?: Record<string, any> | null
8}

返回：

• 成功则返回 HealthQuantitySample 实例，否则为 null

示例：

1const sample = HealthQuantitySample.create({
2  type: 'stepCount',
3  startDate: new Date('2025-07-01T09:00:00'),
4  endDate: new Date('2025-07-01T09:01:00'),
5  value: 200,
6  unit: HealthUnit.count(),
7  metadata: { source: 'manualEntry' }
8})

子类：HealthCumulativeQuantitySample#

HealthCumulativeQuantitySample 表示累计型的健康数据，例如总步数、总距离或总能量消耗等。

新增属性#

新增方法#

sumQuantity(unit: HealthUnit): number#

以指定单位返回该样本的累计值。

示例：

1const totalKcal = cumulativeSample.sumQuantity(HealthUnit.kilocalorie())
2console.log(`总活动能量: ${totalKcal} 千卡`)

quantityValue(unit: HealthUnit): number#

返回值同 sumQuantity()，用于兼容统一接口。

子类：HealthDiscreteQuantitySample#

HealthDiscreteQuantitySample 表示一系列离散时间点上的测量值，例如心率、步数或温度变化等。

新增属性#

新增方法#

示例：

1const avg = discreteSample.averageQuantity(HealthUnit.count())
2const max = discreteSample.maximumQuantity(HealthUnit.count())
3const recent = discreteSample.mostRecentQuantity(HealthUnit.count())
4console.log(`平均: ${avg}, 最大: ${max}, 最近: ${recent}`)

使用场景对比#

相关类型#

• HealthUnit: 表示测量单位（如 kg、bpm、kcal 等）
• HealthQuantityType: 指定测量的数据类型（如步数、心率等）
• HealthDateInterval: 表示一个时间区间（start + end + duration）