Class DataSleepBloodOxygenSaturationMax

Maximum blood oxygen saturation during a sleep session.

Hierarchy

DataPercent
- DataSleepBloodOxygenSaturationMax

Index

Constructors

Properties

value aliases displayType type unit unitSystem

Methods

getDisplayType getDisplayUnit getDisplayValue getType getUnit getUnitSystem getValue isValueTypeValid setValue toJSON fromJSON

Constructors

constructor

new DataSleepBloodOxygenSaturationMax(
value: number,
): DataSleepBloodOxygenSaturationMax
Parameters
- value: number
Returns DataSleepBloodOxygenSaturationMax
Inherited from DataPercent.constructor
- Defined in src/data/data.number.ts:4

Properties

`Protected`value

value: number

`Static`aliases

aliases: string[] = ...

`Static`displayType

displayType: string = 'Maximum Sleep SpO₂'

`Static`type

type: string = 'Maximum Sleep Blood Oxygen Saturation'

`Static`unit

unit: string = '%'

`Static`unitSystem

unitSystem: UnitSystem = UnitSystem.Metric

Methods

getDisplayType

getDisplayType(): string
Returns string
Inherited from DataPercent.getDisplayType
- Defined in src/data/data.ts:58

getDisplayUnit

getDisplayUnit(): string
Returns string
Inherited from DataPercent.getDisplayUnit
- Defined in src/data/data.ts:54

getDisplayValue

getDisplayValue(): string | number | string[]
Returns string | number | string[]
Inherited from DataPercent.getDisplayValue
- Defined in src/data/data.percent.ts:6

getType

getType(): string
Returns string
Inherited from DataPercent.getType
- Defined in src/data/data.ts:46

getUnit

getUnit(): string
Returns string
Inherited from DataPercent.getUnit
- Defined in src/data/data.ts:50

getUnitSystem

getUnitSystem(): UnitSystem
Returns UnitSystem
Inherited from DataPercent.getUnitSystem
- Defined in src/data/data.ts:62

getValue

getValue(_formatForDataType?: string): number
Parameters
- Optional_formatForDataType: string
Returns number
Inherited from DataPercent.getValue
- Defined in src/data/data.number.ts:9

isValueTypeValid

isValueTypeValid(value: unknown): boolean
Parameters
- value: unknown
Returns boolean
Overrides DataPercent.isValueTypeValid
- Defined in src/data/data.sleep.ts:217

setValue

setValue(value: number): this
Parameters
- value: number
Returns this
Inherited from DataPercent.setValue
- Defined in src/data/data.ts:23

toJSON

toJSON(): DataJSONInterface
Returns DataJSONInterface
Inherited from DataPercent.toJSON
- Defined in src/data/data.ts:78

`Static`fromJSON

fromJSON<TData extends DataNumber>(
this: { type: string; new (value: number): TData },
json: DataJSONInterface,
): TData
Rehydrates the sleep SpO₂ aggregate from its canonical JSON object.
Type Parameters
- TData extends DataNumber
Parameters
- this: { type: string; new (value: number): TData }
- json: DataJSONInterface
Returns TData
- Defined in src/data/data.sleep.ts:210