@types/moment-timezone

What is @types/moment-timezone?

@types/moment-timezone provides TypeScript type definitions for the moment-timezone library, which is an extension of moment.js for handling time zones. It allows developers to work with dates and times in different time zones, convert between them, and perform various date-time manipulations with type safety.

What are @types/moment-timezone's main functionalities?

Time Zone Conversion

Convert a date-time from one time zone to another. In this example, a date-time in 'America/New_York' is converted to 'Europe/London'.

const moment = require('moment-timezone');
const date = moment.tz('2023-10-01 12:00', 'America/New_York');
const convertedDate = date.tz('Europe/London');
console.log(convertedDate.format());

Get Time Zone Names

Retrieve a list of all available time zone names. This can be useful for populating a dropdown menu or validating user input.

const moment = require('moment-timezone');
const timeZones = moment.tz.names();
console.log(timeZones);

Get Time Zone Offset

Get the UTC offset for a specific time zone. This can be useful for displaying the offset to users or performing calculations.

const moment = require('moment-timezone');
const offset = moment.tz('America/New_York').utcOffset();
console.log(offset);

Format Date-Time in Time Zone

Format a date-time string in a specific time zone. This example formats a date-time in 'America/New_York' with a specific format.

const moment = require('moment-timezone');
const date = moment.tz('2023-10-01 12:00', 'America/New_York');
console.log(date.format('YYYY-MM-DD HH:mm:ss Z'));

Other packages similar to @types/moment-timezone

date-fns-tz

date-fns-tz is an extension for date-fns that provides time zone support. It offers similar functionalities to moment-timezone, such as converting between time zones and formatting date-times. However, date-fns-tz is often preferred for its functional programming style and tree-shakable modules.

luxon

Luxon is a modern JavaScript library for working with dates and times. It provides built-in support for time zones and offers a more modern API compared to moment-timezone. Luxon is often chosen for new projects due to its better performance and smaller bundle size.

timezone-js

timezone-js is a library for handling time zones in JavaScript. It provides similar functionalities to moment-timezone but is less commonly used. It can be a good alternative for projects that require a lightweight solution.

README

This is a stub types definition for moment-timezone (https://github.com/moment/moment-timezone).

moment-timezone provides its own type definitions, so you don't need @types/moment-timezone installed!