@samual/duration - npm Package Compare versions

Comparing version 0.0.1-72fdab4 to 0.0.1-779e7a7

default.d.ts

+import type { LaxPartial } from "@samual/types";
+/**
+ * A duration of time.
+ *
+ * All properties are optional and must be set to
+ * [`undefined`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined) or an integer
+ * (be able to pass
+ * [`Number.isInteger()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/isInteger)).
+ * Absent properties and properties set to `undefined` are treated the same.
+ * More units of time will be added in the future.
+ *
+ * @example Basic Usage
+ * ```ts
+ * import type { Duration } from "@samual/duration"
+ *
+ * let duration: Duration = { milliseconds: Date.now() }
+ * ```
+ */
+export type Duration = LaxPartial<{
+    /**
+     * The number of years in the duration. Same as 365 days.
+     *
+     * Must be set to
+     * [`undefined`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined) or an
+     * integer (be able to pass
+     * [`Number.isInteger()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/isInteger)).
+     */
+    years: number;
+    /**
+     * The number of days in the duration. Same as 24 hours
+     *
+     * Must be set to
+     * [`undefined`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined) or an
+     * integer (be able to pass
+     * [`Number.isInteger()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/isInteger)).
+     */
+    days: number;
+    /**
+     * The number of hours in the duration. Same as 60 minutes
+     *
+     * Must be set to
+     * [`undefined`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined) or an
+     * integer (be able to pass
+     * [`Number.isInteger()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/isInteger)).
+     */
+    hours: number;
+    /**
+     * The number of minutes in the duration. Same as 60 seconds
+     *
+     * Must be set to
+     * [`undefined`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined) or an
+     * integer (be able to pass
+     * [`Number.isInteger()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/isInteger)).
+     */
+    minutes: number;
+    /**
+     * The number of seconds in the duration. Same as 1000 milliseconds
+     *
+     * Must be set to
+     * [`undefined`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined) or an
+     * integer (be able to pass
+     * [`Number.isInteger()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/isInteger)).
+     */
+    seconds: number;
+    /**
+     * The number of milliseconds in the duration.
+     *
+     * Must be set to
+     * [`undefined`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined) or an
+     * integer (be able to pass
+     * [`Number.isInteger()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/isInteger)).
+     */
+    milliseconds: number;
+}>;
+export { DurationError } from "./DurationError";
+export { formatDuration, FormatDurationError, FormatEmptyDurationError, FormatNonIntegerDurationError, type FormatDurationOptions } from "./formatDuration";
+export { normalizeDuration, NormalizeDurationError, NormalizeNonIntegerDurationError } from "./normalizeDuration";

default.js

+export { DurationError } from "./DurationError.js"
+export {
+	FormatDurationError,
+	FormatEmptyDurationError,
+	FormatNonIntegerDurationError,
+	formatDuration
+} from "./formatDuration.js"
+export { NormalizeDurationError, NormalizeNonIntegerDurationError, normalizeDuration } from "./normalizeDuration.js"

formatDuration.d.ts

@@ -15,3 +15,3 @@ /**
 import { DurationError } from "./DurationError";
-import type { Duration } from "./index";
+import type { Duration } from "./default";
 /**
@@ -18,0 +18,0 @@ * Error that can be thrown by {@linkcode formatDuration()}.

normalizeDuration.d.ts

@@ -17,3 +17,3 @@ /**
 import { DurationError } from "./DurationError";
-import type { Duration } from "./index";
+import type { Duration } from "./default";
 /**
@@ -20,0 +20,0 @@ * Error that can be thrown by {@linkcode normalizeDuration()}.

package.json

 {
   "name": "@samual/duration",
-  "version": "0.0.1-72fdab4",
+  "version": "0.0.1-779e7a7",
   "description": "Normalize and format durations of time.",
@@ -22,10 +22,11 @@ "keywords": [
   "type": "module",
+  "engines": {
+    "node": "^20.10 || ^22 || >=24"
+  },
   "exports": {
-    ".": "./index.js",
-    "./*": "./*.js",
-    "./*.js": "./*.js"
+    ".": "./default.js",
+    "./DurationError": "./DurationError.js",
+    "./formatDuration": "./formatDuration.js",
+    "./normalizeDuration": "./normalizeDuration.js"
   },
-  "engines": {
-    "node": "^20.10 || >=22"
-  },
   "dependencies": {
@@ -32,0 +33,0 @@ "@samual/types": "^0.0.1"

readme.md

@@ -1,4 +0,16 @@
-# `@samual/duration`
+# Samual's Duration Library
 Normalize and format durations of time.
 
-Requires Node.js 20.10+, 22.0+, or above.
+[See Docs.](https://jsr.io/@samual/duration/doc)
+
+## Example
+```ts
+import { type Duration, normalizeDuration, formatDuration } from "@samual/duration"
+
+let duration: Duration = { years: 0, days: 0, hours: 0, milliseconds: Date.now() }
+
+normalizeDuration(duration)
+console.log(duration) // { years: 54, days: 349, hours: 11, milliseconds: 2834227 }
+duration.milliseconds = undefined
+console.log(formatDuration(duration)) // "54 years, 349 days, 11 hours"
+```

index.d.ts

-/**
- * Normalize and format durations of time.
- *
- * @example Basic Usage
- * ```ts
- * import { type Duration, normalizeDuration, formatDuration } from "@samual/duration"
- *
- * let duration: Duration = { years: 0, days: 0, hours: 0, milliseconds: Date.now() }
- *
- * normalizeDuration(duration)
- * console.log(duration) // { years: 54, days: 349, hours: 11, milliseconds: 2834227 }
- * duration.milliseconds = undefined
- * console.log(formatDuration(duration)) // "54 years, 349 days, 11 hours"
- * ```
- * @module
- */
-import type { LaxPartial } from "@samual/types";
-/**
- * A duration of time.
- *
- * All properties are optional and must be set to
- * [`undefined`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined) or an integer
- * (be able to pass
- * [`Number.isInteger()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/isInteger)).
- * Absent properties and properties set to `undefined` are treated the same.
- * More units of time will be added in the future.
- *
- * @example Basic Usage
- * ```ts
- * import type { Duration } from "@samual/duration"
- *
- * let duration: Duration = { milliseconds: Date.now() }
- * ```
- */
-export type Duration = LaxPartial<{
-    /**
-     * The number of years in the duration. Same as 365 days.
-     *
-     * Must be set to
-     * [`undefined`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined) or an
-     * integer (be able to pass
-     * [`Number.isInteger()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/isInteger)).
-     */
-    years: number;
-    /**
-     * The number of days in the duration. Same as 24 hours
-     *
-     * Must be set to
-     * [`undefined`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined) or an
-     * integer (be able to pass
-     * [`Number.isInteger()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/isInteger)).
-     */
-    days: number;
-    /**
-     * The number of hours in the duration. Same as 60 minutes
-     *
-     * Must be set to
-     * [`undefined`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined) or an
-     * integer (be able to pass
-     * [`Number.isInteger()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/isInteger)).
-     */
-    hours: number;
-    /**
-     * The number of minutes in the duration. Same as 60 seconds
-     *
-     * Must be set to
-     * [`undefined`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined) or an
-     * integer (be able to pass
-     * [`Number.isInteger()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/isInteger)).
-     */
-    minutes: number;
-    /**
-     * The number of seconds in the duration. Same as 1000 milliseconds
-     *
-     * Must be set to
-     * [`undefined`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined) or an
-     * integer (be able to pass
-     * [`Number.isInteger()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/isInteger)).
-     */
-    seconds: number;
-    /**
-     * The number of milliseconds in the duration.
-     *
-     * Must be set to
-     * [`undefined`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined) or an
-     * integer (be able to pass
-     * [`Number.isInteger()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/isInteger)).
-     */
-    milliseconds: number;
-}>;
-export { DurationError } from "./DurationError";
-export { formatDuration, FormatDurationError, FormatEmptyDurationError, FormatNonIntegerDurationError, type FormatDurationOptions } from "./formatDuration";
-export { normalizeDuration, NormalizeDurationError, NormalizeNonIntegerDurationError } from "./normalizeDuration";

index.js

-export { DurationError } from "./DurationError.js"
-export {
-	FormatDurationError,
-	FormatEmptyDurationError,
-	FormatNonIntegerDurationError,
-	formatDuration
-} from "./formatDuration.js"
-export { NormalizeDurationError, NormalizeNonIntegerDurationError, normalizeDuration } from "./normalizeDuration.js"

No alert changes

Improved metrics

Total package byte prevSize

26612

0.08%

Number of lines in readme file

17

240%

Worsened metrics

Lines of code

679

-2.3%

No dependency changes