Package detail

time-zone-management-and-date-formatter

dev-humza5ISC1.0.2

utilities packages for epoch-time-zone-and-date-formattor

day, date, day-name, calendar

readme

Date Utilities

A simple npm package providing various date-related utilities, including epoch time conversion, timezone conversion, and retrieving the current timezone.

Installation

Install the package using npm or yarn:

npm i time-zone-management-and-date-formatter

or

yarn add time-zone-management-and-date-formatter

Usage

Import the required functions:

const {
  DateToMiliSeconds,
  MiliSecondsToDate,
  getAverageTimeByEpoch,
  getCurrentDateTime,
  getUserTimeZone,
  convertTimeZone
} = require('time-zone-management-and-date-formatter');

Convert Date to Epoch Time (Milliseconds)

console.log(DateToMiliSeconds(new Date("2024-02-19"))); // Output: Epoch time in milliseconds

Convert Epoch Time to Date Object

console.log(MiliSecondsToDate(1708300800)); // Output: Date object

Get Average Time from Epoch

console.log(getAverageTimeByEpoch(1708300800)); // Output: "HHh MMm SSs"

Get Current Date and Time in a Specific Timezone

pass valid IANA timezone e.g: 'UTC, America/New_York, Asia/Kolkata, Europe/London' do not pass 'UTC + 5, GMT + 5 and etc ..'
console.log(getCurrentDateTime("UTC")); // Output: Current date & time in UTC timezone

Get User's Current Timezone

console.log(getUserTimeZone()); // Output: User's current timezone string

Convert Date from One Timezone to Another

pass valid IANA timezone e.g: 'UTC, America/New_York, Asia/Kolkata, Europe/London' do not pass 'UTC + 5, GMT + 5 and etc ..
console.log(convertTimeZone(1708300800, "America/New_York")); // Output: Formatted date & time in the given timezone

Functionality

Feature Description
Convert Date to Epoch Converts a JavaScript Date object to epoch time in milliseconds
Convert Epoch to Date Converts epoch time (milliseconds) to a JavaScript Date object
Calculate Average Time Returns formatted time difference from epoch
Get Current Date/Time Retrieves the current date and time for a given timezone
Get User Timezone Retrieves the user's current timezone
Convert Between Timezones Converts a timestamp to another timezone

Error Handling

  • Throws an error for invalid dates or timestamps.
  • Throws an error for invalid timezone strings.

License

This project is licensed under the MIT License.