@hardlydifficult/date-time 1.0.6 → 1.0.8

package/README.md

@@ -1,6 +1,6 @@
 # @hardlydifficult/date-time
 
-A TypeScript library providing human-readable duration types and millisecond conversion utilities.
+A TypeScript library for representing time durations and converting them to milliseconds.
 
 ## Installation
 
@@ -14,87 +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)); // 150000
+const milliseconds = toMilliseconds(duration);
+// => 150000
 ```
 
-## Duration Conversion
+## Time Duration Conversion
 
-The package provides a strongly-typed `TimeSpan` interface and a utility function `toMilliseconds` for converting time durations to milliseconds.
-
-### TimeSpan Interface
-
-Represents a time duration with a numeric value and a unit.
-
-| Property | Type     | Description              |
-|----------|----------|-------------------------|
-| value    | `number` | The numeric value        |
-| unit     | `TimeUnit` | The time unit of the value |
-
-### TimeUnit Type
-
-Supported time units:
-
-- `"milliseconds"`
-- `"seconds"`
-- `"minutes"`
-- `"hours"`
-- `"days"`
-
-### toMilliseconds Function
+### toMilliseconds
 
 Converts a `TimeSpan` to its equivalent value in milliseconds.
 
 ```typescript
 import { toMilliseconds, type TimeSpan } from "@hardlydifficult/date-time";
 
-// Convert various durations
-const durations: TimeSpan[] = [
-  { value: 1, unit: "seconds" },
-  { value: 0.5, unit: "hours" },
-  { value: 2, unit: "days" }
-];
-
-durations.forEach(duration => {
-  console.log(toMilliseconds(duration)); // 1000, 1800000, 172800000
-});
-```
+// Seconds
+toMilliseconds({ value: 5, unit: "seconds" }); // => 5000
 
-### Example: Duration to Milliseconds Table
+// Minutes
+toMilliseconds({ value: 1.5, unit: "minutes" }); // => 90000
 
-| Duration                | Milliseconds |
-|-------------------------|--------------|
-| 1 second                | 1,000        |
-| 1.5 minutes             | 90,000       |
-| 2 hours                 | 7,200,000    |
-| 0.5 days                | 43,200,000   |
+// Hours
+toMilliseconds({ value: 1, unit: "hours" }); // => 3600000
 
-## TimeSpan
+// Days
+toMilliseconds({ value: 1, unit: "days" }); // => 86400000
 
-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';
+// Fractional values
+toMilliseconds({ value: 0.5, unit: "seconds" }); // => 500
 ```
 
-### toMilliseconds()
+### TimeSpan Interface
 
-Converts a `TimeSpan` to its equivalent value in milliseconds.
+Represents a duration with a numeric value and a unit.
 
-```typescript
-import { toMilliseconds } from '@hardlydifficult/date-time';
+| Property | Type     | Description             |
+|----------|----------|-------------------------|
+| value    | `number` | The numeric duration    |
+| unit     | `TimeUnit` | The time unit (see below) |
 
-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
-```
+### TimeUnit Type
+
+Supported time units:
 
-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.6",
+  "version": "1.0.8",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "files": [