API Reference

The useTemporal API is organized into the following sections:

Factory Functions

Core functions for creating temporal instances.

• createTemporal - Create a temporal instance

Operations

Functions for manipulating and working with periods.

Time Division

• divide - The signature divide() pattern
• split - Advanced splitting with options
• merge - Merge periods into larger units

Navigation

• period - Create periods (standard or custom)
• next - Navigate to next period
• previous - Navigate to previous period
• go - Navigate by steps

Comparison

• isSame - Check period equality
• contains - Check containment

Utilities

Helper functions for common date operations.

• isWeekend - Check if period is weekend
• isWeekday - Check if period is weekday
• isToday - Check if period is today

Types

TypeScript type definitions.

• Period - Core period interface
• Unit - Time unit types
• Temporal - Temporal instance type
• Adapter - Date adapter interface

Composables

Reactive composables for frameworks.

• usePeriod - Create reactive period

Unit System

Plugin system for custom units.

• defineUnit - Register custom units
• UNITS - Unit constants
• getUnitDefinition - Get unit configuration
• hasUnit - Check if unit is registered

Calendar Units

Special units for consistent calendar grids.

• stableMonth - 42-day grid for months
• stableYear - 52/53-week grid for years

Quick Start

import { createTemporal, usePeriod, divide } from 'usetemporal'

// Create temporal instance
const temporal = createTemporal()

// Create reactive periods
const month = usePeriod(temporal, 'month')
const year = usePeriod(temporal, 'year')

// Divide operations
const days = divide(temporal, month.value, 'day')
const months = divide(temporal, year.value, 'month')

For a complete guide, see Getting Started.