@tempots/ui 1.0.1 → 1.0.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tempots/ui",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "type": "module",
   "main": "./index.cjs",
   "module": "./index.js",

package/utils/make-relative-time.d.ts

@@ -1,3 +1,68 @@
 import { Value } from '@tempots/dom';
-export declare function timeDiffToString(diffInMillis: number): string;
-export declare const makeRelativeTime: (date: Value<Date>, now?: Value<Date>) => import('@tempots/dom').Computed<string>;
+/**
+ * Creates a signal that automatically updates with the current time at a specified frequency.
+ * The signal will clean up its interval when disposed.
+ *
+ * @param frequency - Milliseconds between updates (defaults to 1000ms/1 second)
+ * @returns A Value<Date> that updates with the current time at the specified frequency
+ * @public
+ */
+export declare const makeNowSignal: (frequency?: number) => Value<Date>;
+/**
+ * Converts a time difference in milliseconds to a human-readable relative time string.
+ *
+ * @param diffInMillis - The time difference in milliseconds. Negative values indicate past times,
+ *                       positive values indicate future times.
+ * @returns A human-readable string representing the relative time difference:
+ *          - For very recent times (< 1 minute): "just now" or "in a moment"
+ *          - For other times: formatted strings like "2 minutes ago", "in 3 hours", "yesterday", etc.
+ * @throws {Error} Should never throw due to the Infinity max value in units array
+ * @public
+ */
+export declare const timeDiffToString: (diffInMillis: number) => string;
+/**
+ * Creates a signal that computes the time difference in milliseconds between a target date and a reference date.
+ *
+ * @param date - The target date to compare
+ * @param options - Configuration options
+ * @param options.now - Optional reference date signal (defaults to current time)
+ * @param options.frequency - Update frequency in milliseconds when using default current time (defaults to 10000ms/10 seconds)
+ * @returns A signal containing the time difference in milliseconds. Negative values indicate past times,
+ *          positive values indicate future times. The signal will clean up its resources when disposed.
+ * @public
+ */
+export declare const makeRelativeTimeMillisSignal: (date: Value<Date>, { now, frequency }?: {
+    now?: Value<Date>;
+    frequency?: number;
+}) => import('@tempots/dom').Computed<number>;
+/**
+ * Creates a signal that computes a human-readable relative time string between a target date and a reference date.
+ *
+ * @param date - The target date to compare
+ * @param options - Configuration options
+ * @param options.now - Optional reference date signal (defaults to current time)
+ * @param options.frequency - Update frequency in milliseconds when using default current time (defaults to 10000ms/10 seconds)
+ * @returns 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.
+ * @public
+ */
+export declare const makeRelativeTimeSignal: (date: Value<Date>, options?: {
+    now?: Value<Date>;
+    frequency?: number;
+}) => import('@tempots/dom').Computed<string>;
+/**
+ * Creates a signal that computes a human-readable relative time string between a target date and a reference date.
+ *
+ * @param date - The target date to compare
+ * @param options - Configuration options
+ * @param options.now - Optional reference date signal (defaults to current time)
+ * @param options.frequency - Update frequency in milliseconds when using default current time (defaults to 10000ms/10 seconds)
+ * @returns 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.
+ * @deprecated Use makeRelativeTimeSignal instead
+ * @public
+ */
+export declare const makeRelativeTime: (date: Value<Date>, options?: {
+    now?: Value<Date>;
+    frequency?: number;
+}) => import('@tempots/dom').Computed<string>;

package/utils/ticker.d.ts

@@ -1,5 +1,22 @@
 import { Prop } from '@tempots/dom';
+/**
+ * A property that can be used to force an update. Internally, it's a number that is incremented by one on each tick.
+ * Extends the Prop class with a number value.
+ *
+ * It can be used as a counter Signal.
+ * @public
+ */
 export declare class Ticker extends Prop<number> {
+    /**
+     * Triggers an update of the Ticker by incrementing its internal value.
+     * @returns void
+     */
     readonly tick: () => void;
 }
+/**
+ * Creates a new Ticker instance with an optional initial value.
+ * @param initial - The initial value for the ticker (defaults to 0)
+ * @returns A new Ticker instance that only updates when the value changes
+ * @public
+ */
 export declare const makeTicker: (initial?: number) => Ticker;