dob-to-age


A single small function for turning a date of birth string in the format YYYY, YYYY-MM, or YYYY-MM-DD into an "age" in common terms. This is not a simple mathematical calculation based on the number of milliseconds in a year.

It turns out human logic for "age" is a little weird, and this library tries to match that logic.

For example, let's say today is April 15, 2021 (2021-04-15). If your birth date was 2000-04-15, it's your birthday today! Regardless of what timezone or time of day you were born, you are considered to be 21 on this day. To get this right, we can't simply use new Date() - new Date('2000-04-15') and calculate the number of years by dividing by whole years.

Instead, human logic says:

- Always assume the same time zone.
- Assume that if the day matches, you are n + 1 years old, regardless of the time.

Additionally, in medical settings, it's semi-standard to count days up until 59 days and then switch to months. The values are returned in months up until 23 months; after that, they are returned in years.

This also, means that there are certain scenarios where you can be at 60 days, but not actually two full calendar months. From '2024-03-01' to '2024-04-30' is 60 days, but not 2 full calendar months. This library (unless you pass {forceCalendarUnit: "months"}) will return 2 months for this time period, even though it's not technically 2 full calendar months. After this point, however, it will use calendar months. So it won't return 3 months until '2024-06-01'.

This library tries to encapsulate all that (somewhat screwy) logic. If you do want to force the outcome to be a particular calendar unit you can pass an option to do so (see section below).

It returns an object with values or null

The object returned will have a count in numbers and a unit value.

If the result should be shown in years:

{count: 2, unit: 'years'}

If the result should be shown in months:

{count: 21, unit: 'months'}

If the result should be shown in days (because we're under 2 months):

{count: 18, unit: 'days'}

If it gets any invalid input or errors, it will fail silently and just return null

null

Forcing it to specific calendar unit

It's possible to pass a forcedCalendarUnit option to specify a specific calendar unit for the outcome.

Please note that using this will expose some of the oddities of the fact that calendar units are different lengths depending on the year (due to leap days) or months (due to different month lengths).

Therefore, if you want to force a certain unit like months, you can, but just note that it's using calendar month. Meaning that even though from '2024-03-01' to '2024-04-30' is 60 days, if you pass {forceCalendarUnit: 'months'} the answer will be {count: 1, unit: months}. If you're wanting "age" for the sake of doing some type of scientific math, you're better off using {forceCalendarUnit: 'days'} for the sake of precision.

install

``
npm install dob-to-age
`

usage

`js
import dobToAge from 'dob-to-age'

dobToAge('1982-09-29') // {count: 38, unit: 'years'} (at time of writing this)
// can pass a reference date object
dobToAge('1982-09-29', { referenceDate: new Date('1982-10-29') }) // {count: 30, unit: 'days'}
dobToAge('1982-09-29', {
referenceDate: new Date('1982-10-29'),
forcedCalendarUnit: 'years',
}) // {count: 0, unit: 'years'}
`

test

`
npm test
`

Change log

- 4.0.0: Changed structure of second argument to be an options object. Now supports forcing the output to specific unit ('years' | 'months' | 'days').
- 3.0.0: Updated response object to be {count: number, unit: 'years' | 'months' | 'days'} to make it easier to format results however you want without having to check for existence of properties of the result.
- 2.1.0: Also accept timestamp in milliseconds (as from Date.now()) for reference date.
- 2.0.1: New implementation, returns null or object of either years, months, or days per semi-standard accepted medical nomenclature. Counts days up until 59 days, then switches to 2 months. Returns values in months until 23 months, then returns years. Ignores timezones, etc. Just returns age in the (somewhat illogical) way we do it as humans.
- 1.0.0: Successfully consumed in both front end and back end packages. Considered stable.
- 0.0.2: Fix publishing issue.
- 0.0.1`: First public release.

credits

If you like this follow @HenrikJoreteg on twitter.

license

MIT