Types

TypeScript type definitions for useTemporal.

Core Types

Period

The fundamental data structure representing a time period.

interface Period {
  start: Date     // Inclusive start
  end: Date       // Exclusive end
  type: Unit      // Time unit type
  date: Date      // Reference date
}

Unit

Supported time unit types.

type Unit = 
  | 'year' 
  | 'quarter'
  | 'month' 
  | 'week' 
  | 'day' 
  | 'hour' 
  | 'minute' 
  | 'second'
  | 'custom'
  | (string & {}) // Extensible for custom units

Temporal

The central state container for time navigation.

interface Temporal {
  adapter: Adapter
  browsing: Ref<Period>
  now: Ref<Period>
  weekStartsOn: number
}

Adapter

Interface for date library adapters.

interface Adapter {
  startOf(date: Date, unit: AdapterUnit): Date
  endOf(date: Date, unit: AdapterUnit): Date
  add(date: Date, amount: number, unit: AdapterUnit): Date
  diff(start: Date, end: Date, unit: AdapterUnit): number
}

Configuration Types

CreateTemporalOptions

Options for creating a temporal instance.

interface CreateTemporalOptions {
  date: Date | Ref<Date>
  now?: Date | Ref<Date>
  adapter: Adapter
  weekStartsOn?: number // 0-6 (Sunday to Saturday)
}

SplitOptions

Options for the split operation.

interface SplitOptions {
  unit?: Unit
  count?: number
  duration?: Duration
}