Skip to content

Module: index

Interfaces

Type Aliases

HabitStatus

Ƭ HabitStatus: "completed" | "skipped" | "missed"

Status of a habit for a given day.

  • completed - User marked the habit as done
  • skipped - User intentionally skipped (requires reason)
  • missed - Deadline passed without completion (set by daemon)

Defined in

types.ts:12

Functions

getCurrentDateUtc

getCurrentDateUtc(): string

Returns current UTC date as YYYY-MM-DD string.

Returns

string

Defined in

utils.ts:55


getCurrentTimeUtc

getCurrentTimeUtc(): string

Returns current UTC time as HH:MM string (24-hour).

Returns

string

Defined in

utils.ts:61


getTimezoneOffset

getTimezoneOffset(): number

Returns user's timezone offset in minutes from UTC. Positive = east of UTC, negative = west (opposite of JS getTimezoneOffset).

Returns

number

Defined in

utils.ts:72


isValidDomain

isValidDomain(domain): boolean

Validates that a string is a properly formatted domain name.

Parameters

NameTypeDescription
domainstringDomain to validate (e.g., "reddit.com")

Returns

boolean

true if valid domain format

Defined in

utils.ts:49


localTimeToUtc

localTimeToUtc(localTime, timezoneOffsetMinutes): string

Converts a local time to UTC given the user's timezone offset.

Parameters

NameTypeDescription
localTimestringTime in HH:MM format (24-hour, local timezone)
timezoneOffsetMinutesnumberOffset from UTC in minutes (e.g., -300 for EST)

Returns

string

Time in HH:MM format (24-hour, UTC)

Example

ts
localTimeToUtc('09:00', -300) // '14:00' (EST to UTC)

Defined in

utils.ts:16


utcTimeToLocal

utcTimeToLocal(utcTime, timezoneOffsetMinutes): string

Converts a UTC time to local time given the user's timezone offset.

Parameters

NameTypeDescription
utcTimestringTime in HH:MM format (24-hour, UTC)
timezoneOffsetMinutesnumberOffset from UTC in minutes (e.g., -300 for EST)

Returns

string

Time in HH:MM format (24-hour, local timezone)

Example

ts
utcTimeToLocal('14:00', -300) // '09:00' (UTC to EST)

Defined in

utils.ts:35

Built with VitePress