Skip to main content
DateTime provides utilities for working with dates and times.

​
Type Definition

interface DateTime {
  readonly _id: 'DateTime'
  readonly epochMillis: number
}

​
Constructors

​
now

Gets the current DateTime. 
const now: Effect<DateTime>

​
make

Creates a DateTime from components. 
const make: (options: {
  year: number
  month: number
  day: number
  hours?: number
  minutes?: number
  seconds?: number
}) => DateTime

​
fromDate

Creates a DateTime from a JavaScript Date. 
const fromDate: (date: Date) => DateTime

​
Operations

​
toDate

Converts a DateTime to a JavaScript Date. 
const toDate: (self: DateTime) => Date

​
format

Formats a DateTime as a string. 
const format: (format: string) => (self: DateTime) => string

​
add

Adds a duration to a DateTime. 
const add: (duration: Duration) => (self: DateTime) => DateTime

​
Example

import { DateTime, Duration, Effect } from "effect"

const program = Effect.gen(function* () {
  const now = yield* DateTime.now
  const tomorrow = now.pipe(
    DateTime.add(Duration.days(1))
  )
  console.log(DateTime.toDate(tomorrow))
})

Build docs developers (and LLMs) love

Get started for freeTalk to us