@types/d3-time-format

What is @types/d3-time-format?

@types/d3-time-format provides TypeScript type definitions for the d3-time-format library, which is part of the D3.js suite of modules. This library is used for parsing and formatting dates and times in JavaScript, making it easier to handle date and time data in a consistent and locale-aware manner.

What are @types/d3-time-format's main functionalities?

Formatting Dates

This feature allows you to format dates into human-readable strings using a specified format string. The format string can include various placeholders for different parts of the date.

const d3 = require('d3-time-format');
const formatTime = d3.timeFormat('%B %d, %Y');
console.log(formatTime(new Date())); // Outputs: 'October 05, 2023'

Parsing Dates

This feature allows you to parse date strings into JavaScript Date objects using a specified format string. This is useful for converting string representations of dates into Date objects for further manipulation.

const d3 = require('d3-time-format');
const parseTime = d3.timeParse('%Y-%m-%d');
console.log(parseTime('2023-10-05')); // Outputs: Thu Oct 05 2023 00:00:00 GMT+0000 (Coordinated Universal Time)

Locale-Specific Formatting

This feature allows you to create locale-specific date and time formats. You can define custom formats for dates, times, periods, days, and months, which can be used to format dates in a way that is specific to a particular locale.

const d3 = require('d3-time-format');
const locale = d3.timeFormatLocale({
  dateTime: '%x, %X',
  date: '%-m/%-d/%Y',
  time: '%-I:%M:%S %p',
  periods: ['AM', 'PM'],
  days: ['Sunday', 'Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday'],
  shortDays: ['Sun', 'Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat'],
  months: ['January', 'February', 'March', 'April', 'May', 'June', 'July', 'August', 'September', 'October', 'November', 'December'],
  shortMonths: ['Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec']
});
const formatTime = locale.format('%A, %B %d, %Y');
console.log(formatTime(new Date())); // Outputs: 'Thursday, October 05, 2023'

Other packages similar to @types/d3-time-format

moment

Moment.js is a widely-used library for parsing, validating, manipulating, and formatting dates in JavaScript. It provides a comprehensive set of features for working with dates and times, including support for time zones and locales. Compared to @types/d3-time-format, Moment.js offers more extensive functionality but is also larger in size.

date-fns

date-fns is a modern JavaScript date utility library that provides a wide range of functions for manipulating and formatting dates. It is modular, allowing you to import only the functions you need, which can help reduce bundle size. date-fns is similar to @types/d3-time-format in that it provides functions for formatting and parsing dates, but it also includes many other date manipulation utilities.

luxon

Luxon is a library for working with dates and times in JavaScript, created by one of the Moment.js developers. It offers a modern API and is built on top of the native JavaScript Date and Intl objects. Luxon provides features for parsing, formatting, and manipulating dates and times, with support for time zones and locales. It is similar to @types/d3-time-format in its focus on date and time formatting, but it also includes more advanced features for date manipulation.

README

Installation

npm install --save @types/d3-time-format

Summary

This package contains type definitions for d3JS d3-time-format module (https://github.com/d3/d3-time-format/).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/d3-time-format/v3.

Additional Details

• Last updated: Fri, 22 Sep 2023 20:29:40 GMT
• Dependencies: none
• Global values: none

Credits

These definitions were written by Tom Wanzek, Alex Ford, Boris Yankov, and Nathan Bierema.