@types/luxon

What is @types/luxon?

The @types/luxon package provides TypeScript type definitions for Luxon, a powerful library for dealing with dates and times in JavaScript. It allows developers to use Luxon in TypeScript projects with type checking, enabling better development experience and error handling. The main functionalities include parsing, validating, manipulating, and formatting dates and times.

What are @types/luxon's main functionalities?

Creating and formatting dates

This feature allows the creation of a DateTime object representing the current date and time, and then formats it into an ISO 8601 string.

import { DateTime } from 'luxon';
const now = DateTime.now();
console.log(now.toISO());

Parsing and manipulating dates

This demonstrates how to parse an ISO 8601 date string into a DateTime object, add 1 day and 2 hours to it, and then convert it back to a string.

import { DateTime } from 'luxon';
const dt = DateTime.fromISO('2023-04-01T10:20:30');
const newDt = dt.plus({ days: 1, hours: 2 });
console.log(newDt.toString());

Working with time zones

This shows how to create a DateTime object for the local time and then convert it to a specific time zone.

import { DateTime } from 'luxon';
const local = DateTime.local();
const zoned = local.setZone('Europe/Paris');
console.log(zoned.toString());

Other packages similar to @types/luxon

moment

Moment.js is a legacy date manipulation library that offers a wide range of functionalities similar to Luxon, such as parsing, validation, manipulation, and formatting of dates. However, Luxon is considered a modern alternative with better support for internationalization and immutable data structures.

date-fns

date-fns provides over 200 functions for date manipulation, parsing, and formatting. It is modular, allowing developers to include only the functions they need. Compared to Luxon, date-fns offers a more functional programming approach and is timezone agnostic.

dayjs

Day.js is a lightweight date library that mimics Moment.js API but with a smaller footprint. It is extensible through plugins. While it offers similar functionalities as Luxon, its plugin-based architecture allows for more customization and potentially smaller bundle sizes in projects.

README

Installation

npm install --save @types/luxon

Summary

This package contains type definitions for luxon (https://github.com/moment/luxon#readme).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/luxon.

Additional Details

• Last updated: Wed, 02 Mar 2022 18:01:54 GMT
• Dependencies: none
• Global values: luxon

Credits

These definitions were written by Colby DeHart, Hyeonseok Yang, Jonathan Siebern, Matt R. Wilson, Pietro Vismara, Janeene Beeforth, Jason Yu, Aitor Pérez Rodal, Piotr Błażejewicz, Carson Full, Hugo Silva, and Martin Badin.