Marc Mintel
5397309103
Some checks failed
Build & Deploy / 🔍 Prepare (push) Successful in 20s
Build & Deploy / 🧪 QA (push) Failing after 34s
Build & Deploy / 🏗️ Build (push) Has started running
Build & Deploy / 🚀 Deploy (push) Has been cancelled
Build & Deploy / 🧪 Smoke Test (push) Has been cancelled
Build & Deploy / ⚡ Lighthouse (push) Has been cancelled
Build & Deploy / 🔔 Notify (push) Has been cancelled
31 lines
1.0 KiB
Plaintext
31 lines
1.0 KiB
Plaintext
import type { ContextOptions } from "./types.js";
|
|
/**
|
|
* The {@link fromUnixTime} function options.
|
|
*/
|
|
export interface FromUnixTimeOptions<DateType extends Date = Date>
|
|
extends ContextOptions<DateType> {}
|
|
/**
|
|
* @name fromUnixTime
|
|
* @category Timestamp Helpers
|
|
* @summary Create a date from a Unix timestamp.
|
|
*
|
|
* @description
|
|
* Create a date from a Unix timestamp (in seconds). Decimal values will be discarded.
|
|
*
|
|
* @param unixTime - The given Unix timestamp (in seconds)
|
|
* @param options - An object with options. Allows to pass a context.
|
|
*
|
|
* @typeParam DateType - The `Date` type, the function operates on. Gets inferred from passed arguments. Allows to use extensions like [`UTCDate`](https://github.com/date-fns/utc).
|
|
*
|
|
* @returns The date
|
|
*
|
|
* @example
|
|
* // Create the date 29 February 2012 11:45:05:
|
|
* const result = fromUnixTime(1330515905)
|
|
* //=> Wed Feb 29 2012 11:45:05
|
|
*/
|
|
export declare function fromUnixTime<DateType extends Date = Date>(
|
|
unixTime: number,
|
|
options?: FromUnixTimeOptions<DateType> | undefined,
|
|
): DateType;
|