Standard time handling
Copyright (c) 2022-2025 Check Digit, LLC
The Check Digit time library is the officially sanctioned method for Check Digit services to deal with time. It has date manipulation functions provided by date-fns. Features:
- Stripped down date-fns functions
- date-fns-tz for timezone support
- formatUtc for formatting UTC dates
The date-fns library is included. The only locale currently supported is en-US, but otherwise contains all
available functionality as of v4.1.0 except that the code in fp folder are excluded, which contain functional programming related stuff that is not used at the moment.
Additionally, the date-fns-tz library is included. Contains all
available functionality as of v3.2.0 except that the code in fp folder are excluded, which contain functional programming related stuff that is not used at the moment.
formatUtcThe formatUtc function is a wrapper around date-fns-tz's format function, but with the following differences:
- There is no options argument, timeZone is always UTC.
Generally speaking, formatUtc should be used in place of format or tzFormat, unless non-UTC time zones are required.
npm install @checkdigit/time then:
For date-fns functionality:
``typescript
import { formatUtc } from '@checkdigit/time';
console.log(formatUtc(new Date(), 'yyyy-MM-dd'));
`
The documentation for date-fns is here: https://date-fns.org/
The documentation for date-fns-tz is here: https://github.com/marnusw/date-fns-tz
following are the main steps to sync up with the latest date-fns/date-fns-tz
- clone 3rd party repo
- remove test/fp stuff
- copy/override into @checkdigit/time repo's corresponding folder
- update CHANGELOG.md (it helps to understand the changes since the last update and to prepare accordingly)
- replace imports from '.js' to '.ts'
- Add comments in the beginning of the files to silence ts/lint errors if it forces overwhelming changes otherwise
- check things which compiles but may have other issues, e.g. import { type ZZZ } => import type { ZZZ }
- adjust tsconfig.json compilerOptions if necessary
- apply previous patch (e.g. daylight saving timezone, etc.)
- pass existing local tests
- beta-test across dependent repos to make sure it still works
When updating the latest code from the original repositories, except making all the necessary changes to make them fully typescript compatible, please remember to carry over the patches to overcome the following issues:
- hours is incorrect when it's close to daylight saving timezone threshold
Please search for [PATCH:]` in the existing codebase.