@hardlydifficult/date-time 1.0.7 → 1.0.9

package/README.md

@@ -1,6 +1,6 @@
 # @hardlydifficult/date-time
 
-A TypeScript library for human-readable duration types and millisecond conversion utilities.
+A TypeScript utility for converting time durations to milliseconds with strong typing.
 
 ## Installation
 
@@ -14,90 +14,44 @@ npm install @hardlydifficult/date-time
 import { toMilliseconds, type TimeSpan } from "@hardlydifficult/date-time";
 
 const duration: TimeSpan = { value: 2.5, unit: "minutes" };
-console.log(toMilliseconds(duration)); // 150_000
+const ms = toMilliseconds(duration); // 150_000
 ```
 
-## Time Spans and Conversion
+## TimeSpan Conversion
 
-Convert time durations to milliseconds using a strongly-typed `TimeSpan` interface.
+Converts a time duration to its equivalent in milliseconds using predefined unit multipliers.
 
-### TimeSpan Interface
+### `TimeSpan` Interface
 
 Represents a time duration with a numeric `value` and a `unit`.
 
-```typescript
-interface TimeSpan {
-  value: number;
-  unit: TimeUnit;
-}
-```
+| Field | Type     | Description          |
+|-------|----------|----------------------|
+| value | `number` | The numeric duration |
+| unit  | `TimeUnit` | The time unit      |
+
+### `TimeUnit` Type
 
-Where `TimeUnit` supports:
+Supported time units:
 - `"milliseconds"`
 - `"seconds"`
 - `"minutes"`
 - `"hours"`
 - `"days"`
 
-### toMilliseconds()
+### `toMilliseconds(timeSpan)`
 
-Converts a `TimeSpan` to its equivalent in milliseconds.
+Converts a `TimeSpan` to milliseconds.
 
 ```typescript
 import { toMilliseconds } from "@hardlydifficult/date-time";
 
-// Minutes to milliseconds
-toMilliseconds({ value: 5, unit: "minutes" }); // 300_000
-
-// Days to milliseconds
-toMilliseconds({ value: 1, unit: "days" }); // 86_400_000
-
-// Fractional hours
-toMilliseconds({ value: 0.75, unit: "hours" }); // 2_700_000
-```
-
-| Unit       | Multiplier (ms) |
-|------------|-----------------|
-| milliseconds | 1               |
-| seconds      | 1,000           |
-| minutes      | 60,000          |
-| hours        | 3,600,000       |
-| days         | 86,400,000      |
-
-### Example: Duration to Milliseconds Table
-
-| Duration                | Milliseconds |
-|-------------------------|--------------|
-| 1 second                | 1,000        |
-| 1.5 minutes             | 90,000       |
-| 2 hours                 | 7,200,000    |
-| 0.5 days                | 43,200,000   |
-
-## TimeSpan Usage Details
+// Convert 2 hours
+toMilliseconds({ value: 2, unit: "hours" }); // 7_200_000
 
-A strongly-typed duration representation that pairs a numeric value with a time unit, enabling human-readable time specifications that convert to milliseconds.
-
-### Type Definition
-
-```typescript
-interface TimeSpan {
-  value: number;
-  unit: TimeUnit;
-}
-
-type TimeUnit = 'milliseconds' | 'seconds' | 'minutes' | 'hours' | 'days';
-```
-
-### Additional Examples
-
-```typescript
-import { toMilliseconds } from '@hardlydifficult/date-time';
-
-toMilliseconds({ value: 2, unit: 'seconds' });      // 2000
-toMilliseconds({ value: 1, unit: 'hours' });        // 3600000
-toMilliseconds({ value: 0.5, unit: 'seconds' });    // 500
-toMilliseconds({ value: 0, unit: 'minutes' });      // 0
-toMilliseconds({ value: 1, unit: 'days' });         // 86400000
-```
+// Convert 0.5 days
+toMilliseconds({ value: 0.5, unit: "days" }); // 43_200_000
 
-Supports all time units (`milliseconds`, `seconds`, `minutes`, `hours`, `days`) and handles fractional values and zero correctly.
+// 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.7",
+  "version": "1.0.9",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "files": [