scdate 0.2.0 → 0.2.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +13 -1
  2. package/package.json +3 -6
package/README.md CHANGED
@@ -11,11 +11,23 @@ Features:
11
11
  - Time zone required for operations only when relevant
12
12
  - Serializable to simple ISO formatted strings
13
13
 
14
+ ## Dependencies
15
+
16
+ This package has the following dependencies:
17
+
18
+ - `date-fns-tz`: used for time zone calculations
19
+ - `date-fns`: it is a peer dependency of `date-fns-tz`
20
+ - `@date-fns/utc`: used for its `UTCDateMini` implementation that simplifies some of the time calculations
21
+
14
22
  ## Design Decisions
15
23
 
16
24
  ### ISO formatted values
17
25
 
18
- A subset of [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) is used as the valid format for SDate, STime, and STimestamp. This was done to make the values human readable.
26
+ A subset of [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) is used as the valid format for SDate, STime, and STimestamp. This was done because:
27
+
28
+ - the format is human readable
29
+ - the values are easily sortable as strings
30
+ - the values are easily comparable as strings
19
31
 
20
32
  ### No seconds in time components
21
33
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "scdate",
3
- "version": "0.2.0",
3
+ "version": "0.2.1",
4
4
  "type": "module",
5
5
  "exports": {
6
6
  ".": "./dist/index.js"
@@ -30,18 +30,15 @@
30
30
  "postpublish": "pinst --enable",
31
31
  "prepare": "husky"
32
32
  },
33
- "peerDependencies": {
34
- "date-fns": "^3"
35
- },
36
33
  "dependencies": {
37
34
  "@date-fns/utc": "^1.2.0",
35
+ "date-fns": "^3.6.0",
38
36
  "date-fns-tz": "^3.1.3"
39
37
  },
40
38
  "devDependencies": {
41
39
  "@eslint/js": "^9.1.1",
42
40
  "@tsconfig/strictest": "^2.0.5",
43
41
  "@types/node": "^20.12.7",
44
- "date-fns": "^3",
45
42
  "eslint": "^9.1.1",
46
43
  "husky": "^9.0.11",
47
44
  "lint-staged": "^15.2.2",
@@ -50,7 +47,7 @@
50
47
  "rimraf": "^5.0.5",
51
48
  "tsdoc-markdown": "^0.6.0",
52
49
  "typescript": "^5.4.5",
53
- "typescript-eslint": "^7.7.1",
50
+ "typescript-eslint": "^7.8.0",
54
51
  "vitest": "^1.5.2"
55
52
  },
56
53
  "prettier": {