@tempots/ui

@tempots/ui > makeRelativeTimeSignal

makeRelativeTimeSignal() function

Creates a signal that computes a human-readable relative time string between a target date and a reference date.

Signature:

makeRelativeTimeSignal: (date: Value&lt;Date&gt;, options?: {
    now?: Value&lt;Date&gt;;
    frequency?: number;
}) =&gt; import('@tempots/dom').Computed&lt;string&gt;

Parameters

Parameter	Type	Description
date	Value<Date>	The target date to compare
options	{ now?: Value<Date>; frequency?: number; }	(Optional) Configuration options

Returns: import('@tempots/dom').Computed<string>

A signal containing a human-readable relative time string (e.g., "2 minutes ago", "in 3 hours"). The signal will clean up its resources when disposed.