@rr0/time v0.8.1

@rr0/time

Zero-dependency JavaScript API for managing fuzzy dates.

This package implements EDTF (levels 0, 1 and 2), which extended over the ISO-8601 standard to add fuzziness, and was eventually integrated in ISO 8601-2019.

By fuzziness, we mean:

• uncertainty (?), like "maybe June 2025"
• (im)precision (X), to express that some date has missing component(s) info
• approximation (~), like "around June 2025"
• both (%), like "maybe around June 2025"

Accordingly, this API is split in level-specific sub-packages.

classDiagram
    namespace level0 {
        class Level0Date {
        }
        class Level0Duration {
        }
        class Level0Interval {
        }
    }
    namespace level1 {
        class Level1Date {
            uncertain: boolean
            approximate: boolean
        }
        class Level1Duration {
        }
        class Level1Interval {
        }
    }
    namespace level2 {
        class Level2Date {
        }
        class Level2Duration {
        }
        class Level2Interval {
        }
    }
    Level0Date <|-- Level1Date
    Level1Date <|-- Level2Date
    Level1Duration <|-- Level2Duration
    Level0Interval <|-- Level1Interval
    Level1Interval <|-- Level2Interval

You can use Level0Date only for instance, but using Level2Date will implicitly rely on Level1Date which implicitly rely on Level0Date, as each of those standards are extending one on another.

Data types

This package supports fuzziness/no fuzziness for:

• Dates
• Date components (year, month, day, hour, minute, second, timeshift), each of these referencing a Unit
• Intervals between two dates
• Durations

Date component

A date component is a value with a unit, which allows only valid values.

classDiagram
    class Validator {
        name: string
        validate(value: number): boolean
    }
    class DateComponent {
        value: number
    }
    DateComponent --> Unit: unit
    class Unit {
        name: string
        min: number
        max: number
        duration(): number
    }
    Unit --> Unit: subUnit
    Unit --> Validator: validator

Each specialization of DateComponent:

• can parse a different format
• is validated by a specific validator.

classDiagram
    class DateComponent {
    }
    class Year {
        fromString(str)$: Year
    }
    DateComponent <|-- Year
    class Month {
        fromString(str)$: Month
    }
    DateComponent <|-- Month
    class Day {
        fromString(str)$: Day
    }
    DateComponent <|-- Day
    class Hour {
        fromString(str)$: Hour
    }
    DateComponent <|-- Hour
    class Minute {
        fromString(str)$: Minute
    }
    DateComponent <|-- Minute
    class Second {
        fromString(str)$: Second
    }
    DateComponent <|-- Second

Date

A date is an aggregation of (optional) date components:

classDiagram
    class Year {
    }
    class Month {
    }
    class Day {
    }
    class Hour {
    }
    class Minute {
    }
    class Second {
    }
    class Date {
        getTime(): number
        compare(otherDate): number
        isEqual(otherDate): boolean
        isBefore(otherDate): boolean
        isAfter(otherDate): boolean
        delta(otherDate): Level0Duration
        toString(): string
        fromString(str)$: Level0Date
        newInstance()$: Level0Date
    }
    Date --> Year: year?
    Date --> Month: month?
    Date --> Day: day?
    Date --> Hour: hour?
    Date --> Minute: minute?
    Date --> Second: second?

Interval

An interval is an aggregation of one or two dates:

classDiagram
    class Date {
        
    }
    class Interval {
        toString(): string
        fromString(str)$: Interval
    }
    Interval --> Date: start?
    Interval --> Date: end?

Duration

A duration is a special type of component whose value has less restricted bounds;

classDiagram
    class DateComponent {
        value: number
        unit: Unit
    }
    class Duration {
        toString(): string
        toSpec()
        fromString(str)$: Duration
        between(dateStart, dateEnd)$: Duration
    }
    DateComponent <|-- Duration

Features

Each data type can be:

• instantiated programmatically (like new EdtfDate({year: 2024, month: 8, day: 25, uncertain: true}));
• parsed from EDTF strings by default (like EdtfDate.fromString("2024-08-25~")), but you can use your own parser;
• rendered in EDTF format by default (like edtfDate.toString()), but you can use your own renderer, to render in some language words for instance.

Examples

The examples below apply for both JavaScript and TypeScript.

Imports

To allow using only what you need, the API is exported per level.

You can import a type from its precise location:

import { Level2Date } from "@rr0/time/src/level2/date/Level2Date.mjs"

or from package root (but it will load all code):

import { Level2Date } from "@rr0/time"

You can also add the alias of your choice to an imported type:

import { Level2Date as EdtfDate } from "@rr0/time"

Parsing

Dates, date components (year, month, etc.), intervals or durations can be instantiated fromString.

Dates

import { Level2Date as EdtfDate } from "@rr0/time"

const maybeAugust = EdtfDate.fromString("2024-?08-25")
maybeAugust.month.value // 8
maybeAugust.month.uncertain // true
maybeAugust.year.uncertain // false
maybeAugust.uncertain // true
const aroundMarch2025 = EdtfDate.fromString("2025-03~")
aroundMarch2025.approximate = true

Intervals

Date intervals can be parsed:

import { Level2Interval as EdtfInterval } from "@rr0/time/level2/interval/index.mjs"

const maybeAugust = EdtfDate.fromString("2024/2025-~06")
maybeAugust.start.year      // 2024
maybeAugust.end.year        // 2025
maybeAugust.end.month       // 6
maybeAugust.end.approximate // true

Individual date components

Each date calendar (year, month, day) and time (hour, minute, second) component can also be individually instantiated.

import { Level2Year as EdtfYear } from "@rr0/time/level2/year/index.mjs"

const inTheFifities = EdtfYear.fromString("195X")

Duration

You can select the API level you want to use. For example using level 0:

import {Level2Duration as Duration} from "@rr0/time"

const aroundTenMinutes = Duration.fromString("P10M~")
aroundTenMinutes.value            // 10 * GregorianCalendar.minute.duration
aroundTenMinutes.toSpec().minutes // 10

Programmatic API

Dates, date components (year, month, etc.), intervals or durations can be instantiated through their own constructors.

Components

Each date calendar and time component can be individually instantiated.

import { Level2Year as EdtfYear } from "@rr0/time/level2/year/index.mjs"

const someYear = new EdtfYear(1985)
someYear.value  // "1985"
const currentYear = EdtfYear.newInstance()
someYear.value  // Displays current year

Date

You can select the API level you want to use. For example using level 0:

import { Level2Date as EdtfDate } from "@rr0/time/level2/date/index.mjs"

const currentDate = EdtfDate.newInstance()
const someDate = new EdtfDate({ year: 1985, month: 4, day: 12 })

API

classDiagram
    namespace level0 {
        class Level0Duration {
            
        }
        class Level0Date {
            year?
            month?
            day?
            hour?
            minute?
            second?
            getTime(): number
            compare(otherDate): number
            isEqual(otherDate): boolean
            isBefore(otherDate): boolean
            isAfter(otherDate): boolean
            delta(otherDate): Duration
            toString(): string
            fromString(str)$: Level0Date
            newInstance()$: Level0Date
        }
        class Level0Component {
            value: number
        }
        class Level0Year {
        }
        class Level0Month {
        }
        class Level0Day {
        }
        class Level0Hour {
        }
        class Level0Minute {
        }
        class Level0Second {
        }
    }
    namespace level1 {
        class Level1Date {
            uncertain: boolean
            approximate: boolean
        }
    }
    namespace level2 {
        class Level2Date {
        }
    }
    Level0Component <|-- Level0Year
    Level0Component <|-- Level0Month
    Level0Component <|-- Level0Day
    Level0Component <|-- Level0Hour
    Level0Component <|-- Level0Minute
    Level0Component <|-- Level0Second
    Level0Component --> CalendarUnit: unit
    CalendarUnit --> CalendarUnit: subUnit
    CalendarUnit --> EDTFValidator: validator
    Level0Date --> Level0Year: year?
    Level0Date --> Level0Month: month?
    Level0Date --> Level0Day: day?
    Level0Date --> Level0Hour: hour?
    Level0Date --> Level0Minute: minute?
    Level0Date --> Level0Second: second?
    Level0Date <|-- Level1Date
    Level1Date <|-- Level2Date

Date

Several APIs are available on dates, such as:

maybeAugust.isEqual(aroundMarch2025)  // false
maybeAugust.isBefore(aroundMarch2025) // true
aroundMarch2025.isAfter(maybeAugust)  // true
const delta = aroundMarch2025.delta(maybeAugust).toSpec()
delta.months //  6
delta.days   // 16