A typescript package for converting the fields in your objects to strings.

Let's say you're requesting data from another service, and you want to convert all relevant fields to dates from strings, before manipulating the data or saving it in your database. That's where strdate comes in! It will iterate over the entire object and convert all relevant fields from strings to dates.

> npm install strdate

import strdate from strdate;

Before reading this, you should know the different kinds of dates in typescript. You can read about them here

Don't worry, strdate will keep them as strings:

const a = strdate("My regular string!");
// a = "My regular string!"

By default they'll be kept as strings, but If you want them to be converted to dates you can set the convertFourDigitNumbers option to true.

const a = strdate("1977");
const b = strdate("1977", { convertFourDigitNumbers: true });
// a = "1977", b = new Date("1977")

strdate will keep them as numbers.

const a = strdate(456);
const b = strdate(5678.8);
const c = strdate(1977);
// a = 456, b = 5678.8, c = 1977

strdate will keep them as booleans.

const a = strdate(true);
const b = strdate(false);
// a = true, b = false

By default, strdate will convert all ISO date strings into dates only if they're full ISO dates.

const a = strdate("2024-12-01T15:25:55.567Z");
// a = new Date("2024-12-01T15:25:55.567Z")

If the year/month/day exceed their maximum respectively (for example 2024-23-01T15:25:55.567Z or 2024-12-40T15:25:55.567Z), strdate will keep them as strings:

const a = strdate("2024-30-01T15:25:55.567Z");
// a = "2024-30-01T15:25:55.567Z"

strdate will also convert ISO dates which are missing miliseconds:

const a = strdate("2024-06-01T15:25:55Z");
// a = new Date("2024-06-01T15:25:55Z")

If you want to convert them to dates as well, set the convertNonFullIsoDates to true. By default, strdate will keep them as strings.

const a = strdate("1945-04-23");
const b = strdate("1945-04-23", { convertNonFullIsoDates: true });
// a = "1945-04-23", b = new Date("1945-04-23");

By default, strdate will keep them as strungs, but if you want to convert them as well just set the convertShortDates option to true.

const a = strdate("03/25/2015");
const b = strdate("03/25/2015", { convertShortDates: true });
// a = "03/25/2015", b = new Date("03/25/2015");

By default, strdate will keep them as strungs, but if you want to convert them as well just set the convertLongDates option to true.

const a = strdate("May 3 1869");
const b = strdate("May 3 1869", { convertLongDates: true });
// a = "May 3 1869", b = new Date("May 3 1869");

For each value in the object, strdate will implement the mentioned above behaviours and return the new object.

const objToConvert = {
  name: "my name",
  age: 12,
  birthDay: "2024-12-01T15:25:55.567Z",
  kids: {
    son: "name",
    daughter: "03/25/2015",
  },
};
const convertedObject = strdate(objToConvert, { convertShortDates: true });
/* convertedObject = {
    name: "my name",
    age: 12,
    birthDay: new Date("2024-12-01T15:25:55.567Z"),
    kids: {
    son: "name",
    daughter: new Date("03/25/2015"),
    }
}
*/

Note: If the convertShortDates was set to false here, The field objToConvert.kids.daughter would have remained a string.

strdate will access every field and nested field in order to ensure everything relevant is converted.

The behaviour strdate implements for arrays is identical to the behaviour twords objects.

const arr = ["2024-06-15", 34, "Feb 2 1977", false, "Hello world", "2008-02"];
const a = strdate(arr, {
  convertLongDates: true,
  convertNonFullIsoDates: true,
});
/* a = [
    new Date("2024-06-15"),
    34,
    new Date("Feb 2 1977"),
    false,
    "Hello world",
    new Date("2008-02"),  
]
*/

Note: If the convertLongDates and the convertNonFullIsoDates options were set to false here, all the elements that were converted to dates would have remained strings.

The following configuration options for strdate are:

• convertShortDates (false by default) - If you want strdate to convert JS short date strings to dates, set to true.
• convertLongDates (false by default) - If you want strdate to convert JS long date strings to dates, set to true.
• convertNonFullIsoDates (false by default) - If you want strdate to convert non full ISO date strings to dates, set to true.
• convertFourFigitNumbers (false by default) - If you want strdate to convert four figit number strings to dates, set to true.

In order to run the tests, clone the repo to your computer and run npm test.

If there are any issues, just open an issue in the repository and the owners will fix them.