date.md

Date and Time Utilities

https://github.com/RoamJS/roamjs-components/blob/main/src/date

Utilities for parsing and manipulating dates and times within the Roam Research application are provided in the https://github.com/RoamJS/roamjs-components/blob/main/src/date directory. Key functionalities include:

• Natural Language Date Parsing: The parseNlpDate function leverages the chrono-node library to interpret natural language dates (e.g., "yesterday", "next Monday"). Custom parsing and refinement logic enhance its robustness. The startOfWeek, endOfWeek, startOfMonth, endOfMonth, startOfYear, and endOfYear functions from date-fns determine the start and end of various periods. The ORDINAL_WORD_DICTIONARY and ORDINAL_REGEX assist in parsing ordinal words and numbers. The assignDay function assigns year, month, and day components to a ParsingComponents object.

• Roam Date UID Parsing: The parseRoamDateUid function converts Roam Research date UIDs (formatted as "month-date-year") into JavaScript Date objects. It splits the input string, converts the components to numbers, and constructs a Date object, adjusting the month value to match JavaScript's zero-indexed months.

• Constants: The constants.ts file provides constants like MONTHS, an array of month names, and regular expressions (DAILY_NOTE_PAGE_REGEX and DAILY_NOTE_PAGE_TITLE_REGEX) for matching and validating daily note page titles in Roam Research.

For detailed discussions on constants and parsing functions, refer to the subsections Constants and Date Parsing.