@aniky-wq/formatdatejs
v1.1.0
Published
A simple utitlity with date-time functions
Downloads
5
Maintainers
Readme
formatDateTime JS Utility
A simple JavaScript utility function to format timestamps or dates into custom string formats.
Features
- Format a timestamp or current date/time into a string.
- Supports basic tokens:
YYYY,YY,MM,DD,hh,mm,ss/SS. - Returns an empty string for invalid dates.
Usage
Import
import { formatDateTime } from "@aniky-wq/formatdatejs";
// or, if using a relative path in your project:
// import { formatDateTime } from './src/formatDateTime.js';Example
// Format current date/time
const dateStr = formatDateTime({}); // Default: 'YYYY-MM-DD hh:mm:ss'
// Format a specific timestamp
const timestamp = 1716902400000; // e.g., May 28, 2024
const formatted = formatDateTime({ timestamp, format: "DD/MM/YYYY hh:mm:ss" });
console.log(formatted); // '28/05/2024 00:00:00'
// Custom format
formatDateTime({ timestamp: Date.now(), format: "YY-MM-DD hh:mm" }); // e.g., '25-05-28 14:30'API
formatDateTime({ timestamp, format })
timestamp(optional): The date/time to format (number, string, or Date). If omitted, uses the current date/time.format(optional): The output format string. Default is'YYYY-MM-DD hh:mm:ss'.
Supported Format Tokens
| Token | Description | Example | | ----- | -------------- | ------- | | YYYY | 4-digit year | 2025 | | YY | 2-digit year | 25 | | MM | Month (01-12) | 05 | | DD | Day (01-31) | 28 | | hh | Hour (00-23) | 14 | | mm | Minute (00-59) | 09 | | ss/SS | Second (00-59) | 07 |
Notes
- If no timestamp is provided, the current date/time is used.
- Returns an empty string for invalid timestamps.
- Only supports a basic set of tokens (no AM/PM, day names, time zones, etc.).
- No localization or custom token support.
License
MIT
