@segment/isodate-traverse

What is @segment/isodate-traverse?

@segment/isodate-traverse is an npm package designed to traverse through objects and convert ISO 8601 date strings into JavaScript Date objects. This can be particularly useful when dealing with JSON data that includes date strings, ensuring that date manipulations and comparisons are handled correctly.

What are @segment/isodate-traverse's main functionalities?

Convert ISO 8601 date strings to Date objects

This feature allows you to traverse through an object and automatically convert any ISO 8601 date strings into JavaScript Date objects. This ensures that date manipulations and comparisons are handled correctly.

const traverse = require('@segment/isodate-traverse');

const data = {
  createdAt: '2023-10-01T12:00:00Z',
  user: {
    lastLogin: '2023-10-02T15:30:00Z'
  }
};

const result = traverse(data);
console.log(result);
// Output:
// {
//   createdAt: 2023-10-01T12:00:00.000Z,
//   user: {
//     lastLogin: 2023-10-02T15:30:00.000Z
//   }
// }

Other packages similar to @segment/isodate-traverse

date-fns

date-fns is a comprehensive library for working with dates in JavaScript. It provides a wide range of functions for parsing, formatting, and manipulating dates. Unlike @segment/isodate-traverse, date-fns does not automatically traverse objects to convert date strings but offers extensive utilities for date operations.

moment

Moment.js is a popular library for parsing, validating, manipulating, and formatting dates in JavaScript. While it offers powerful date manipulation capabilities, it does not automatically traverse objects to convert ISO date strings like @segment/isodate-traverse.

luxon

Luxon is a modern JavaScript library for working with dates and times, built by one of the Moment.js developers. It provides a more modern API and better support for internationalization. Similar to date-fns and Moment.js, Luxon does not automatically traverse objects to convert date strings.

README

isodate-traverse

Traverse an object (or array) and convert all ISO strings into Dates.

Installation

$ npm install @segment/isodate-traverse

Example

var traverse = require('@segment/isodate-traverse');

var obj = {
  date: '2013-09-04T00:57:26.434Z'
};

var traversed = traverse(obj);
// {
//   date: [object Date]
// }

API

traverse(obj, [strict])

Traverse an obj, converting all ISO strings to real Dates. By default, strict mode will be enabled, requiring at least YYYY-MM-DD