@solid-primitives/date/dist/utils.d.ts

Collection of reactive primitives and utility functions, providing easier ways to deal with dates in SolidJS

import type { Countdown, DateInit, RelativeFormatMessages } from "./types.js";
/**
 * @param init timestamp `number` | date `string` | `Date` instance
 * @returns `Date` instance
 */
export declare const getDate: (init: DateInit) => Date;
/**
 * @param init timestamp `number` | date `string` | `Date` instance
 * @returns timestamp `number`
 */
export declare const getTime: (init: DateInit) => number;
/**
 * Get the time difference between two dates *[ms]*
 */
export declare const getDateDifference: (from: Date, to: Date) => number;
/**
 * Provides broken down time remaining from a time difference.
 * @param difference time difference between two dates *[ms]*
 * @returns countdown object with keys: `days`, `hours`, `minutes`, etc.
 */
export declare const getCountdown: (difference: number) => Countdown;
/**
 * Apply basic formatting to a `Date` instance.
 * @example
 * const date = new Date("2020 1 11")
 * formatDate(date) // => '2020-01-10'
 */
export declare const formatDate: (date: Date) => string;
/**
 * Applies relative time formatting based on a time difference from **now**.
 *
 * @param difference time difference between a date and now *[ms]*
 * @param messages custom messages for changing formatting
 * @returns formatted string, e.g. *"2 seconds ago"*, *"in 3 weeks"*...
 */
export declare function formatDateRelative(difference: number, messages?: Partial<RelativeFormatMessages>): string;