dateformatmaster
v1.1.0
Published
This package provides to get date and time with various formats like createPaddedDate, formattedDateWithOffset, addDaySuffix, shortDate, getCurrentMonth, getTime, getCurrentTime, etc.
Downloads
4
Readme
dateformatmaster
dateformatmaster is a TypeScript library for formatting dates and times. It provides various functions to create padded dates, add day suffixes, format dates with offsets, retrieve the current time, and more.
Installation
You can install the library using npm:
npm install dateformatmaster
Usage First, import the functions you need from the library:
import { getCurrentTime, getTime, getCurrentMonth, shortDate, addDaySuffix, createPaddedDate, formattedDateWithOffset, delay } from 'dateformatmaster';
Functions
getCurrentTime(offset: number): Promise
Calculates the current date and time adjusted by the specified offset in days. const currentTime = await getCurrentTime(2); console.log(currentTime); // Outputs adjusted date in "MM/DD/YYYY" format
getTime(): Promise
Retrieves the current time in "hh AM/PM" format, adjusted to the America/New_York time zone. const time = await getTime(); console.log(time); // Outputs current time in "hh:mm AM/PM" format
getCurrentMonth(): Promise
Retrieves the name of the current month. const month = await getCurrentMonth(); console.log(month); // Outputs current month name
shortDate(date: string): Promise
Formats the given date into a short date format (e.g., "Jan 01"). const formattedDate = await shortDate("2024-06-01"); console.log(formattedDate); // Outputs "Jun 01"
addDaySuffix(day: string | number): Promise
Adds the appropriate suffix to the given day number (e.g., 1 -> 1st, 2 -> 2nd). const dayWithSuffix = await addDaySuffix(21); console.log(dayWithSuffix); // Outputs "21st"
createPaddedDate(date: string): Promise
Creates a padded date string with leading zeros for month and day (e.g., "04/02/2024"). const paddedDate = await createPaddedDate("4/2/2024"); console.log(paddedDate); // Outputs "04/02/2024"
formattedDateWithOffset(daysOffset: number): Promise
Formats the current date with an offset in "yyyy-mm-dd" format. const formattedDate = await formattedDateWithOffset(5); console.log(formattedDate); // Outputs adjusted date in "yyyy-mm-dd" format
Contributing
Contributions are welcome! Please open an issue or submit a pull request on GitHub.
License
This project is licensed under the ISC License.
Author
Vibhanshu Srivastava
Repository
GitHub
Bugs and Issues
If you encounter any issues, please report them here.