O3 Framework / ageAsDuration
ageAsDuration(
birthDate,currentDate):null|DurationInput
Defined in: packages/framework/esm-utils/src/age-helpers.ts:22
Gets the age of a person as a structured duration object, following NHS Digital guidelines (Tables 7 and 8) for which units to include based on the person’s age.
ConfigType
The birthDate. If null, returns null.
ConfigType = ...
Optional. If provided, calculates the age at the provided date instead of now.
null | DurationInput
A DurationInput object, or null if birthDate is null or unparseable.
https://webarchive.nationalarchives.gov.uk/ukgwa/20160921162509mp_/http://systems.digital.nhs.uk/data/cui/uig/patben.pdf
// For infants, returns fine-grained units
ageAsDuration('2024-07-29', '2024-07-30') // => { hours: 24 }
// For adults (>= 18), returns years only
ageAsDuration('2000-01-15', '2024-07-30') // => { years: 24 }