Day

Day module provides date object related helper functions. The main function day is actually Day.js with a little syntax suger for ease of use.

The Day object exported from Sefirot extends following Day.js plugins.

• UTC
• Timezone
• RelativeTime

You may import the module from support/Day.

import * as Day from '@globalbrain/sefirot/lib/support/Day'

Day

The Dayjs type alias.

import { Dayjs } from 'dayjs'

type Day = Dayjs

import { type Day } from '@globalbrain/sefirot/lib/support/Day'

Input

The ConfigType alias from Day.js.

import { ConfigType } from 'dayjs'

type Input = ConfigType

import { type ConfigType } from '@globalbrain/sefirot/lib/support/Day'

Ymd

The year, month, and date object interface.

interface Ymd {
  year: number | null
  month: number | null
  date: number | null
}

import { type Ymd } from '@globalbrain/sefirot/lib/support/Day'

Hms

The hour, minute, and second object interface.

interface Hms {
  hour: string | null
  minute: string | null
  second: string | null
}

import { type Hms } from '@globalbrain/sefirot/lib/support/Day'

day

Creates a new Day instance.

function day(input?: Input): Day

import { day } from '@globalbrain/sefirot/lib/support/Day'

const d = day()

d.format('YYYY-MM-DD')

utc

Creates a new UTC Day instance. This function is the alias of dayjs.utc.

function utc(input?: Input): Day

import { utc } from '@globalbrain/sefirot/lib/support/Day'

utc()

tz

Creates a new timezone aware Day instance. This function is the alias of dayjs.tz.

function utc(input?: Input): Day

import { tz } from '@globalbrain/sefirot/lib/support/Day'

tz('1985-10-10 12:00:00', 'Asia/Tokyo')
  .tz('America/New_York')
  .format('YYYY/MM/DD HH:mm:ss')

createYmd

Creates a new Ymd object.

function createYmd(
  year: number | null = null,
  month: number | null = null,
  date: number | null = null
): Ymd

import { createYmd } from '@globalbrain/sefirot/lib/support/Day'

createYmd(1985, 10, 10)

createHms

Creates a new Hms object.

function createHms(
  hour: string | null = null,
  minute: string | null = null,
  second: string | null = null
): Hms

import { createHms } from '@globalbrain/sefirot/lib/support/Day'

createHms('12', '00', '00')