isToday

Checks whether a Luxon DateTime falls on the same calendar day as another DateTime, or today when no comparison value is provided. Pass the optional comparison value in tests to avoid depending on the real clock.

Importing

import { isToday } from '@almighty-shogun/utils'

Usage

import { DateTime } from 'luxon'
import { isToday } from '@almighty-shogun/utils'

const shouldHighlight = isToday(DateTime.now());

// true

Parameters

Name	Type	Description
dateTime	DateTime	Date to check.
today	DateTime	Optional comparison date.

Returns

true when both values share the same day.

Type signature

declare function isToday(dateTime: DateTime, today?: DateTime): boolean;