@hardlydifficult/date-time 1.0.8 → 1.0.9

package/README.md

@@ -1,6 +1,6 @@
 # @hardlydifficult/date-time
 
-A TypeScript library for representing time durations and converting them to milliseconds.
+A TypeScript utility for converting time durations to milliseconds with strong typing.
 
 ## Installation
 
@@ -14,50 +14,44 @@ npm install @hardlydifficult/date-time
 import { toMilliseconds, type TimeSpan } from "@hardlydifficult/date-time";
 
 const duration: TimeSpan = { value: 2.5, unit: "minutes" };
-const milliseconds = toMilliseconds(duration);
-// => 150000
+const ms = toMilliseconds(duration); // 150_000
 ```
 
-## Time Duration Conversion
+## TimeSpan Conversion
 
-### toMilliseconds
+Converts a time duration to its equivalent in milliseconds using predefined unit multipliers.
 
-Converts a `TimeSpan` to its equivalent value in milliseconds.
+### `TimeSpan` Interface
 
-```typescript
-import { toMilliseconds, type TimeSpan } from "@hardlydifficult/date-time";
-
-// Seconds
-toMilliseconds({ value: 5, unit: "seconds" }); // => 5000
-
-// Minutes
-toMilliseconds({ value: 1.5, unit: "minutes" }); // => 90000
+Represents a time duration with a numeric `value` and a `unit`.
 
-// Hours
-toMilliseconds({ value: 1, unit: "hours" }); // => 3600000
+| Field | Type     | Description          |
+|-------|----------|----------------------|
+| value | `number` | The numeric duration |
+| unit  | `TimeUnit` | The time unit      |
 
-// Days
-toMilliseconds({ value: 1, unit: "days" }); // => 86400000
+### `TimeUnit` Type
 
-// Fractional values
-toMilliseconds({ value: 0.5, unit: "seconds" }); // => 500
-```
+Supported time units:
+- `"milliseconds"`
+- `"seconds"`
+- `"minutes"`
+- `"hours"`
+- `"days"`
 
-### TimeSpan Interface
+### `toMilliseconds(timeSpan)`
 
-Represents a duration with a numeric value and a unit.
+Converts a `TimeSpan` to milliseconds.
 
-| Property | Type     | Description             |
-|----------|----------|-------------------------|
-| value    | `number` | The numeric duration    |
-| unit     | `TimeUnit` | The time unit (see below) |
+```typescript
+import { toMilliseconds } from "@hardlydifficult/date-time";
 
-### TimeUnit Type
+// Convert 2 hours
+toMilliseconds({ value: 2, unit: "hours" }); // 7_200_000
 
-Supported time units:
+// Convert 0.5 days
+toMilliseconds({ value: 0.5, unit: "days" }); // 43_200_000
 
-- `"milliseconds"`
-- `"seconds"`
-- `"minutes"`
-- `"hours"`
-- `"days"`
+// Handle fractional values
+toMilliseconds({ value: 1.5, unit: "minutes" }); // 90_000
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hardlydifficult/date-time",
-  "version": "1.0.8",
+  "version": "1.0.9",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "files": [