@hardlydifficult/date-time 1.0.7 → 1.0.8

package/README.md

@@ -1,6 +1,6 @@
 # @hardlydifficult/date-time
 
-A TypeScript library for human-readable duration types and millisecond conversion utilities.
+A TypeScript library for representing time durations and converting them to milliseconds.
 
 ## Installation
 
@@ -14,90 +14,50 @@ 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 milliseconds = toMilliseconds(duration);
+// => 150000
 ```
 
-## Time Spans and Conversion
+## Time Duration Conversion
 
-Convert time durations to milliseconds using a strongly-typed `TimeSpan` interface.
+### toMilliseconds
 
-### TimeSpan Interface
-
-Represents a time duration with a numeric `value` and a `unit`.
+Converts a `TimeSpan` to its equivalent value in milliseconds.
 
 ```typescript
-interface TimeSpan {
-  value: number;
-  unit: TimeUnit;
-}
-```
-
-Where `TimeUnit` supports:
-- `"milliseconds"`
-- `"seconds"`
-- `"minutes"`
-- `"hours"`
-- `"days"`
-
-### toMilliseconds()
+import { toMilliseconds, type TimeSpan } from "@hardlydifficult/date-time";
 
-Converts a `TimeSpan` to its equivalent in milliseconds.
+// Seconds
+toMilliseconds({ value: 5, unit: "seconds" }); // => 5000
 
-```typescript
-import { toMilliseconds } from "@hardlydifficult/date-time";
+// Minutes
+toMilliseconds({ value: 1.5, unit: "minutes" }); // => 90000
 
-// Minutes to milliseconds
-toMilliseconds({ value: 5, unit: "minutes" }); // 300_000
+// Hours
+toMilliseconds({ value: 1, unit: "hours" }); // => 3600000
 
-// Days to milliseconds
-toMilliseconds({ value: 1, unit: "days" }); // 86_400_000
+// Days
+toMilliseconds({ value: 1, unit: "days" }); // => 86400000
 
-// Fractional hours
-toMilliseconds({ value: 0.75, unit: "hours" }); // 2_700_000
+// Fractional values
+toMilliseconds({ value: 0.5, unit: "seconds" }); // => 500
 ```
 
-| 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
+### TimeSpan Interface
 
-A strongly-typed duration representation that pairs a numeric value with a time unit, enabling human-readable time specifications that convert to milliseconds.
+Represents a duration with a numeric value and a unit.
 
-### Type Definition
+| Property | Type     | Description             |
+|----------|----------|-------------------------|
+| value    | `number` | The numeric duration    |
+| unit     | `TimeUnit` | The time unit (see below) |
 
-```typescript
-interface TimeSpan {
-  value: number;
-  unit: TimeUnit;
-}
+### TimeUnit Type
 
-type TimeUnit = 'milliseconds' | 'seconds' | 'minutes' | 'hours' | 'days';
-```
-
-### Additional Examples
-
-```typescript
-import { toMilliseconds } from '@hardlydifficult/date-time';
+Supported time units:
 
-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
-```
-
-Supports all time units (`milliseconds`, `seconds`, `minutes`, `hours`, `days`) and handles fractional values and zero correctly.
+- `"milliseconds"`
+- `"seconds"`
+- `"minutes"`
+- `"hours"`
+- `"days"`

package/package.json

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