feat: add date util

.github/workflows/pull.yml

@@ -5,7 +5,7 @@ on:
     types: [labeled]
 
 env:
-  NODE_VERSION: 18
+  NODE_VERSION: 20
 
 jobs:
   security:

.github/workflows/push.yml

@@ -10,7 +10,7 @@ on:
       - main
 
 env:
-  NODE_VERSION: 18
+  NODE_VERSION: 20
 
 jobs:
   test:

CHANGELOG.md

@@ -4,6 +4,11 @@ by [**SWR Audio Lab**](https://lab.swr.de/)
 
 ## Changelog
 
+- 2023-06-16 - v1.2.0
+  - feat: `getYearMonthDay` can now return a date with strings (YYYY-MM-DD)
+  - refactor!: `getYearMonthDay` now returns an integer
+  - refactor!: `getIsoRelativeTime` is now called `getISOAndRelativeTime`
+
 - 2023-04-19 - v1.1.3
   - fix: don't run linter on dependabot-pr
   - fix: use `toReadable` in `pluralize` helper

packages/date/README.md

@@ -135,6 +135,11 @@ const { getYearMonthDay } = require('@swrlab/utils/packages/date')
 
 Then use the toolkit:
 
+```js
+getYearMonthDay('2038-01-19T03:14:08.000', true)
+// '2038-01-19'
+```
+
 ```js
 getYearMonthDay('2038-01-19T03:14:08.000')
 // '20380119'

packages/date/index.js

@@ -3,9 +3,9 @@ const getDateHourMinutes = require('../../utils/date/getDateHourMinutes')
 const getDayMonthYear = require('../../utils/date/getDayMonthYear')
 const getFullRelativeTime = require('../../utils/date/getFullRelativeTime')
 const getHourMinutes = require('../../utils/date/getHourMinutes')
-const getIsoRelativeTime = require('../../utils/date/getIsoRelativeTime')
+const getISOAndRelativeTime = require('../../utils/date/getISOAndRelativeTime')
 const getRelativeTime = require('../../utils/date/getRelativeTime')
-const getYearMonthDay = require('../../utils/date/getYearMonthDay')
+const getYearMonthDay = require('../../utils/date/toYearMonthDay')
 const revYearMonthDay = require('../../utils/date/revYearMonthDay')
 
 // export packages
@@ -14,7 +14,7 @@ module.exports = {
 	getDayMonthYear,
 	getFullRelativeTime,
 	getHourMinutes,
-	getIsoRelativeTime,
+	getISOAndRelativeTime,
 	getRelativeTime,
 	getYearMonthDay,
 	revYearMonthDay,

utils/date/getCurrentISO.js

@@ -0,0 +1,5 @@
+const getISO = require('./toISO')
+const getNow = require('./getNow')
+
+// get MS value of current time
+module.exports = () => getISO(getNow())

utils/date/getCurrentMs.js

@@ -0,0 +1,5 @@
+const getMs = require('./getMs')
+const getNow = require('./getNow')
+
+// get MS value of current time
+module.exports = () => getMs(getNow())

utils/date/getMs.js

@@ -0,0 +1,2 @@
+// get MS value of timestamp
+module.exports = (date) => date.valueOf()

utils/date/getNow.js

@@ -0,0 +1,4 @@
+const { DateTime } = require('luxon')
+
+// get iso date with relative years
+module.exports = () => DateTime.now()

utils/date/getRelativeTime.js

@@ -2,3 +2,6 @@ const { DateTime } = require('luxon')
 
 // get relative years (returns 'in YY Jahren')
 module.exports = (date) => DateTime.fromISO(date).setLocale('de').toRelative()
+
+
+

utils/date/parseISO.js

@@ -0,0 +1,4 @@
+const { DateTime } = require('luxon')
+
+// parse ISO format
+module.exports = (iso) => DateTime.fromISO(iso)

utils/date/toISO.js

@@ -0,0 +1,2 @@
+// get ISO format
+module.exports = (date) => date.toUTC().toISO()

utils/date/toYearMonthDay.js

@@ -0,0 +1,7 @@
+const { DateTime } = require('luxon')
+
+// get YYYYMMDD (returns '19700101')
+module.exports = (date, withDashes) =>
+	withDashes
+		? DateTime.fromISO(date).setLocale('de').toFormat('yyyy-LL-dd')
+		: parseInt(DateTime.fromISO(date).setLocale('de').toFormat('yyyyLLdd'))