@pvorona/duration 0.1.0 → 0.2.0

package/README.md

@@ -1,6 +1,6 @@
 # @pvorona/duration
 
-An immutable duration type with unit conversions, comparisons, and basic arithmetic.
+An immutable ESM-only duration type with unit conversions, comparisons, and basic arithmetic.
 
 ## Install
 
@@ -8,25 +8,44 @@ An immutable duration type with unit conversions, comparisons, and basic arithme
 npm i @pvorona/duration
 ```
 
+This package is ESM-only. Import it from ESM modules instead of `require(...)`.
+
 ## Usage
 
 ### Create and convert
 
 ```ts
-import { minutes } from '@pvorona/duration';
+import { duration, TimeUnit } from '@pvorona/duration';
 
-const d = minutes(5);
-d.toSeconds(); // 300
-d.toMilliSeconds(); // 300_000
+const d = duration(2, TimeUnit.Minute);
+d.toSeconds(); // 120
+d.toMilliseconds(); // 120_000
+duration(250, TimeUnit.Millisecond).toSeconds(); // 0.25
 ```
 
+### Compose from multiple units
+
+```ts
+import { duration } from '@pvorona/duration';
+
+const total = duration({ minutes: 1, seconds: 30 });
+total.toSeconds(); // 90
+
+const negative = duration({ hours: -1, minutes: -30 });
+negative.toMilliseconds(); // -5_400_000
+```
+
+`duration(parts)` accepts only the exact plural keys `milliseconds`, `seconds`, `minutes`, `hours`, `days`, `weeks`, `months`, and `years`.
+
+All non-zero parts must share the same sign. For example, `duration({ hours: 1, minutes: -30 })` throws `TypeError`.
+
 ### Compare
 
 ```ts
-import { milliSeconds, seconds } from '@pvorona/duration';
+import { milliseconds, seconds } from '@pvorona/duration';
 
 const a = seconds(1);
-const b = milliSeconds(900);
+const b = milliseconds(900);
 
 a.greaterThan(b); // true
 a.compare(b); // 1
@@ -35,10 +54,10 @@ a.compare(b); // 1
 ### Arithmetic
 
 ```ts
-import { add, milliSeconds, seconds } from '@pvorona/duration';
+import { add, milliseconds, seconds } from '@pvorona/duration';
 
-const total = add(seconds(1), milliSeconds(500));
-total.toMilliSeconds(); // 1500
+const total = add(seconds(1), milliseconds(500));
+total.toMilliseconds(); // 1500
 ```
 
 ### Between dates
@@ -51,52 +70,69 @@ const elapsed = since(startedAt);
 elapsed.toSeconds(); // ~2
 ```
 
-## API
+### Apply a duration to a date
 
-### `const enum TimeUnit`
+```ts
+import { addTo, seconds, subtractFrom } from '@pvorona/duration';
 
-Time units supported by `duration(value, unit)` and `d.to(unit)`.
+const start = new Date(1_000);
 
-```ts
-export const enum TimeUnit {
-  MilliSecond,
-  Second,
-  Minute,
-  Hour,
-  Day,
-  Week,
-  Month,
-  Year,
-}
+addTo(start, seconds(2)).getTime(); // 3_000
+subtractFrom(start, seconds(2)).getTime(); // -1_000
 ```
 
-Notes:
+## Important semantics
+
+- ESM-only package: use `import`, not `require(...)`.
+- Duration values are frozen branded objects created by this package. Use `isDuration(...)` for unknown inputs instead of duck typing.
+- Compare durations by value with `d.equals(other)` or `isEqual(a, b)`, not `===`.
+- Do not spread, JSON-serialize, or structured-clone `Duration` values as a transport format. Serialize your own explicit shape and reconstruct with `milliseconds(...)` for finite values or `infinite` for the sentinel.
+- `DurationParts` is constructor input only. It is not a serialized `Duration` format and should not be treated as one.
+- `instant` is the exported zero-duration constant, but any zero-valued duration has `isInstant === true`.
+- The public millisecond APIs are `TimeUnit.Millisecond`, `milliseconds(...)`, and `toMilliseconds()`.
+- `Month` is treated as 30 days and `Year` as 365.25 days. These are approximations, not calendar-aware durations.
+- Negative finite durations are valid. `between(...)`, `since(...)`, arithmetic, and comparisons can produce or operate on negative values.
+- Constructors accept only finite numeric inputs. `infinite` is the only supported non-finite duration.
+- `duration(parts)` requires at least one supported plural key, rejects unknown keys, rejects non-finite part values, and rejects mixed-sign non-zero parts.
+- `add(infinite, x)`, `subtract(infinite, finite)`, `multiply(infinite, positive finite)`, and `divide(infinite, positive finite)` return `infinite`.
+- `addTo(date, duration)` and `subtractFrom(date, duration)` do exact timestamp arithmetic equivalent to `new Date(date.getTime() +/- duration.toMilliseconds())`.
+- `addTo(...)` and `subtractFrom(...)` reject invalid dates, reject `infinite`, and reject result timestamps outside the JavaScript `Date` range.
+- `addTo(...)` and `subtractFrom(...)` are timestamp-based, not calendar-aware. Local clock time may shift across DST or timezone offset transitions.
+- `Date` values only have millisecond precision, so the date helpers follow native JavaScript `Date` semantics for fractional-millisecond timestamps.
+- Invalid units, invalid dates, non-finite scalar inputs, divide-by-zero, `subtract(infinite, infinite)`, `subtract(finite, infinite)`, `multiply(infinite, 0)`, `multiply(infinite, negative)`, and `divide(infinite, negative)` throw `TypeError`.
 
-- `Month` is treated as **30 days**
-- `Year` is treated as **365.25 days**
+## API
 
-Example:
+### `TimeUnit`
 
-```ts
-import { duration, TimeUnit } from '@pvorona/duration';
+The package exports both:
 
-duration(2, TimeUnit.Hour).toMinutes(); // 120
-```
+- `type TimeUnit`: the union of the supported runtime unit values
+- `const TimeUnit`: the runtime constants accepted by `duration(value, unit)` and `d.to(unit)`
+
+- `TimeUnit.Millisecond`
+- `TimeUnit.Second`
+- `TimeUnit.Minute`
+- `TimeUnit.Hour`
+- `TimeUnit.Day`
+- `TimeUnit.Week`
+- `TimeUnit.Month`
+- `TimeUnit.Year`
 
 ### `type Duration`
 
-An opaque, immutable duration value.
+An opaque, immutable duration value. Duration instances are branded by the package, so use `isDuration(...)` for unknown inputs and compare values with `equals(...)` / `isEqual(...)` rather than `===`.
 
 #### Properties
 
-- **`isFinite: boolean`**: `true` unless the duration is infinite
-- **`isInfinite: boolean`**: `true` for `infinite`
-- **`isInstant: boolean`**: `true` for zero duration (`instant`)
+- **`isFinite: boolean`**: `true` for finite durations
+- **`isInfinite: boolean`**: `true` only for `infinite`
+- **`isInstant: boolean`**: `true` for any zero duration (including `instant`)
 
 #### Conversions
 
 - **`to(unit: TimeUnit): number`**: convert to an arbitrary unit
-- **`toMilliSeconds(): number`**
+- **`toMilliseconds(): number`**
 - **`toSeconds(): number`**
 - **`toMinutes(): number`**
 - **`toHours(): number`**
@@ -114,28 +150,44 @@ An opaque, immutable duration value.
 - **`greaterThanOrEqual(other: Duration): boolean`**
 - **`compare(other: Duration): -1 | 0 | 1`**
 
-Example (properties + conversion + comparison):
+Example:
 
 ```ts
-import { milliSeconds, seconds, type Duration } from '@pvorona/duration';
+import { milliseconds, seconds, type Duration } from '@pvorona/duration';
 
 function isShort(d: Duration) {
   return d.isFinite && d.toSeconds() < 5;
 }
 
 const a = seconds(1);
-const b = milliSeconds(900);
+const b = milliseconds(900);
 
 isShort(a); // true
 a.greaterThan(b); // true
 ```
 
+### `type DurationParts`
+
+Strict constructor input for `duration(parts)`. Supported keys:
+
+- `milliseconds?: number`
+- `seconds?: number`
+- `minutes?: number`
+- `hours?: number`
+- `days?: number`
+- `weeks?: number`
+- `months?: number`
+- `years?: number`
+
+At least one key is required. All non-zero keys must share the same sign.
+
 ### Function API
 
 #### Constructors
 
 - `duration(value: number, unit: TimeUnit): Duration`
-- `milliSeconds(value: number): Duration`
+- `duration(parts: DurationParts): Duration`
+- `milliseconds(value: number): Duration`
 - `seconds(value: number): Duration`
 - `minutes(value: number): Duration`
 - `hours(value: number): Duration`
@@ -148,6 +200,8 @@ a.greaterThan(b); // true
 
 - `between(start: Date, end: Date): Duration`
 - `since(start: Date): Duration`
+- `addTo(date: Date, duration: Duration): Date`
+- `subtractFrom(date: Date, duration: Duration): Date`
 
 #### Arithmetic helpers
 
@@ -173,6 +227,6 @@ import { isDuration, seconds } from '@pvorona/duration';
 
 const maybe: unknown = seconds(1);
 if (isDuration(maybe)) {
-  maybe.toMilliSeconds(); // ok, narrowed
+  maybe.toMilliseconds(); // ok, narrowed
 }
 ```

package/dist/index.js

@@ -1,205 +1,256 @@
-import { isObject as i } from "@pvorona/assert";
-var c = /* @__PURE__ */ ((t) => (t[t.MilliSecond = 0] = "MilliSecond", t[t.Second = 1] = "Second", t[t.Minute = 2] = "Minute", t[t.Hour = 3] = "Hour", t[t.Day = 4] = "Day", t[t.Week = 5] = "Week", t[t.Month = 6] = "Month", t[t.Year = 7] = "Year", t))(c || {});
-const n = /* @__PURE__ */ Symbol("milliSeconds"), o = {
-  0: 1,
-  1: 1e3,
-  2: 60 * 1e3,
-  3: 3600 * 1e3,
+import { isObject as T, hasOwnKey as b } from "@pvorona/assert";
+const N = {
+  Millisecond: 0,
+  Second: 1,
+  Minute: 2,
+  Hour: 3,
+  Day: 4,
+  Week: 5,
+  Month: 6,
+  Year: 7
+}, e = N, w = {
+  milliseconds: e.Millisecond,
+  seconds: e.Second,
+  minutes: e.Minute,
+  hours: e.Hour,
+  days: e.Day,
+  weeks: e.Week,
+  months: e.Month,
+  years: e.Year
+}, r = /* @__PURE__ */ Symbol("milliseconds"), D = new Set(Object.values(e)), S = new Set(
+  Object.keys(w)
+), d = {
+  [e.Millisecond]: 1,
+  [e.Second]: 1e3,
+  [e.Minute]: 60 * 1e3,
+  [e.Hour]: 3600 * 1e3,
   /** Note: Does not account for leap second */
-  4: 1440 * 60 * 1e3,
-  5: 10080 * 60 * 1e3,
+  [e.Day]: 1440 * 60 * 1e3,
+  [e.Week]: 10080 * 60 * 1e3,
   /** Note: Does not account for leap year */
-  6: (
+  [e.Month]: (
     /* 30 days */
     720 * 60 * 60 * 1e3
   ),
   /** Note: Does not account for leap year */
-  7: (
+  [e.Year]: (
     /* 365.25 days */
     365.25 * 24 * 60 * 60 * 1e3
   )
-}, a = {
-  [n]: 0,
+};
+function p(n) {
+  if (D.has(n))
+    return n;
+  throw new TypeError("Expected a valid time unit.");
+}
+function c(n, t) {
+  if (Number.isFinite(n))
+    return n;
+  throw new TypeError(`Expected \`${t}\` to be finite.`);
+}
+function a(n, t) {
+  const i = n.getTime();
+  if (!Number.isNaN(i))
+    return i;
+  throw new TypeError(`Expected \`${t}\` to be a valid date.`);
+}
+function y(n, t) {
+  const i = new Date(n);
+  return a(i, t), i;
+}
+function g(n) {
+  if (S.has(n))
+    return n;
+  throw new TypeError(`Expected \`${n}\` to be a supported duration part.`);
+}
+function _(n) {
+  const t = Object.entries(n);
+  if (t.length === 0)
+    throw new TypeError("Expected `parts` to include at least one duration part.");
+  let i = 0, o;
+  for (const [E, M] of t) {
+    const h = g(E), l = c(M, `parts.${h}`);
+    if (l === 0)
+      continue;
+    const m = Math.sign(l);
+    if (o == null && (o = m), o !== m)
+      throw new TypeError("Expected non-zero duration parts to share the same sign.");
+    i += l * d[w[h]];
+  }
+  return i;
+}
+function O(n, t) {
+  if (Number.isNaN(n) || n === Number.NEGATIVE_INFINITY)
+    throw new TypeError("Expected duration milliseconds to be finite or `Infinity`.");
+  if (n !== 1 / 0 || t?.allowInfinite)
+    return n;
+  throw new TypeError("Expected duration milliseconds to be finite.");
+}
+const U = {
+  [r]: 0,
   isFinite: !1,
   isInfinite: !1,
   isInstant: !1,
-  to(t) {
-    return this[n] / o[t];
+  to(n) {
+    return this[r] / d[p(n)];
   },
-  toMilliSeconds() {
-    return this.to(
-      0
-      /* MilliSecond */
-    );
+  toMilliseconds() {
+    return this.to(e.Millisecond);
   },
   toSeconds() {
-    return this.to(
-      1
-      /* Second */
-    );
+    return this.to(e.Second);
   },
   toMinutes() {
-    return this.to(
-      2
-      /* Minute */
-    );
+    return this.to(e.Minute);
   },
   toHours() {
-    return this.to(
-      3
-      /* Hour */
-    );
+    return this.to(e.Hour);
   },
   toDays() {
-    return this.to(
-      4
-      /* Day */
-    );
+    return this.to(e.Day);
   },
   toWeeks() {
-    return this.to(
-      5
-      /* Week */
-    );
+    return this.to(e.Week);
   },
   toMonths() {
-    return this.to(
-      6
-      /* Month */
-    );
+    return this.to(e.Month);
   },
   toYears() {
-    return this.to(
-      7
-      /* Year */
-    );
+    return this.to(e.Year);
   },
-  equals(t) {
-    return this[n] === t[n];
+  equals(n) {
+    return this[r] === n[r];
   },
-  lessThan(t) {
-    return this[n] < t[n];
+  lessThan(n) {
+    return this[r] < n[r];
   },
-  lessThanOrEqual(t) {
-    return this[n] <= t[n];
+  lessThanOrEqual(n) {
+    return this[r] <= n[r];
   },
-  greaterThan(t) {
-    return this[n] > t[n];
+  greaterThan(n) {
+    return this[r] > n[r];
   },
-  greaterThanOrEqual(t) {
-    return this[n] >= t[n];
+  greaterThanOrEqual(n) {
+    return this[r] >= n[r];
   },
-  compare(t) {
-    return this.lessThan(t) ? -1 : this.greaterThan(t) ? 1 : 0;
+  compare(n) {
+    return this.lessThan(n) ? -1 : this.greaterThan(n) ? 1 : 0;
   }
 };
-function f(t, r) {
-  const s = Object.create(a);
-  return s[n] = t * o[r], s.isFinite = t !== 1 / 0, s.isInfinite = t === 1 / 0, s.isInstant = t === 0, Object.freeze(s);
-}
-function e(t, r) {
-  return f(t, r);
-}
-function u(t) {
-  return e(
-    t,
-    0
-    /* MilliSecond */
-  );
+function s(n, t) {
+  const i = O(n, t), o = Object.create(U);
+  return o[r] = i, o.isFinite = Number.isFinite(i), o.isInfinite = i === 1 / 0, o.isInstant = i === 0, Object.freeze(o);
 }
-function d(t) {
-  return e(
-    t,
-    1
-    /* Second */
-  );
+function u(n, t) {
+  if (T(n))
+    return s(_(n));
+  const i = c(n, "value"), o = p(t);
+  return s(i * d[o]);
 }
-function I(t) {
-  return e(
-    t,
-    2
-    /* Minute */
-  );
+function x(n) {
+  return u(n, e.Millisecond);
 }
-function S(t) {
-  return e(
-    t,
-    3
-    /* Hour */
-  );
+function z(n) {
+  return u(n, e.Second);
 }
-function y(t) {
-  return e(
-    t,
-    4
-    /* Day */
-  );
+function A(n) {
+  return u(n, e.Minute);
 }
-function M(t) {
-  return e(
-    t,
-    5
-    /* Week */
-  );
+function Y(n) {
+  return u(n, e.Hour);
 }
-function D(t) {
-  return e(
-    t,
-    6
-    /* Month */
-  );
+function v(n) {
+  return u(n, e.Day);
 }
-function O(t) {
-  return e(
-    t,
-    7
-    /* Year */
-  );
+function j(n) {
+  return u(n, e.Week);
+}
+function C(n) {
+  return u(n, e.Month);
 }
-function h(t, r) {
-  return u(r.getTime() - t.getTime());
+function H(n) {
+  return u(n, e.Year);
 }
-function b(t) {
-  return h(t, /* @__PURE__ */ new Date());
+function F(n, t) {
+  const i = a(n, "start"), o = a(t, "end");
+  return s(o - i);
 }
-function g(t, r) {
-  return u(t[n] + r[n]);
+function V(n) {
+  return F(n, /* @__PURE__ */ new Date());
+}
+function I(n) {
+  if (!n.isInfinite)
+    return n.toMilliseconds();
+  throw new TypeError("Expected `duration` to be finite.");
+}
+function W(n, t) {
+  return n.isInfinite || t.isInfinite ? f : s(n[r] + t[r]);
+}
+function R(n, t) {
+  if (n.isInfinite && t.isInfinite)
+    throw new TypeError("Cannot subtract `infinite` from `infinite`.");
+  if (n.isInfinite)
+    return f;
+  if (t.isInfinite)
+    throw new TypeError("Cannot subtract `infinite` from a finite duration.");
+  return s(n[r] - t[r]);
+}
+function q(n, t) {
+  const i = c(t, "multiplier");
+  if (!n.isInfinite)
+    return s(n[r] * i);
+  if (i > 0)
+    return f;
+  throw new TypeError(
+    "Cannot multiply `infinite` by zero or a negative number."
+  );
 }
-function E(t, r) {
-  return u(t[n] - r[n]);
+function K(n, t) {
+  const i = c(t, "divisor");
+  if (i === 0)
+    throw new TypeError("Cannot divide by zero.");
+  if (!n.isInfinite)
+    return s(n[r] / i);
+  if (i > 0)
+    return f;
+  throw new TypeError("Cannot divide `infinite` by a negative number.");
 }
-function k(t, r) {
-  return u(t[n] * r);
+function $(n, t) {
+  const i = a(n, "date"), o = I(t);
+  return y(i + o, "result");
 }
-function p(t, r) {
-  return u(t[n] / r);
+function L(n, t) {
+  const i = a(n, "date"), o = I(t);
+  return y(i - o, "result");
 }
-const q = u(1 / 0), N = u(0);
-function j(t) {
-  return i(t) && n in t;
+const f = s(1 / 0, { allowInfinite: !0 }), P = x(0);
+function B(n) {
+  return T(n) && b(n, r);
 }
-function w(t, r) {
-  return t[n] === r[n];
+function G(n, t) {
+  return n[r] === t[r];
 }
 export {
-  c as TimeUnit,
-  g as add,
-  h as between,
-  y as days,
-  p as divide,
-  e as duration,
-  S as hours,
-  q as infinite,
-  N as instant,
-  j as isDuration,
-  w as isEqual,
-  u as milliSeconds,
-  I as minutes,
-  D as months,
-  k as multiply,
-  d as seconds,
-  b as since,
-  E as subtract,
-  M as weeks,
-  O as years
+  e as TimeUnit,
+  W as add,
+  $ as addTo,
+  F as between,
+  v as days,
+  K as divide,
+  u as duration,
+  Y as hours,
+  f as infinite,
+  P as instant,
+  B as isDuration,
+  G as isEqual,
+  x as milliseconds,
+  A as minutes,
+  C as months,
+  q as multiply,
+  z as seconds,
+  V as since,
+  R as subtract,
+  L as subtractFrom,
+  j as weeks,
+  H as years
 };

package/dist/lib/duration.d.ts

@@ -1,21 +1,50 @@
-export declare const enum TimeUnit {
-    MilliSecond = 0,
-    Second = 1,
-    Minute = 2,
-    Hour = 3,
-    Day = 4,
-    Week = 5,
-    Month = 6,
-    Year = 7
-}
+declare const TIME_UNIT_VALUES: {
+    readonly Millisecond: 0;
+    readonly Second: 1;
+    readonly Minute: 2;
+    readonly Hour: 3;
+    readonly Day: 4;
+    readonly Week: 5;
+    readonly Month: 6;
+    readonly Year: 7;
+};
+/** Supported runtime unit values used by `TimeUnit`. */
+export type TimeUnit = (typeof TIME_UNIT_VALUES)[keyof typeof TIME_UNIT_VALUES];
+/**
+ * Runtime time-unit constants accepted by `duration(value, unit)` and `d.to(unit)`.
+ *
+ * `Month` uses a 30-day approximation and `Year` uses a 365.25-day approximation.
+ */
+export declare const TimeUnit: {
+    readonly [Key in keyof typeof TIME_UNIT_VALUES]: TimeUnit;
+};
+declare const DURATION_PART_TIME_UNITS: {
+    readonly milliseconds: TimeUnit;
+    readonly seconds: TimeUnit;
+    readonly minutes: TimeUnit;
+    readonly hours: TimeUnit;
+    readonly days: TimeUnit;
+    readonly weeks: TimeUnit;
+    readonly months: TimeUnit;
+    readonly years: TimeUnit;
+};
+type DurationPartKey = keyof typeof DURATION_PART_TIME_UNITS;
+type RequireAtLeastOne<T> = {
+    [Key in keyof T]-?: Required<Pick<T, Key>> & Partial<Omit<T, Key>>;
+}[keyof T];
+/** Input bag accepted by `duration(parts)` for strict multi-unit construction. */
+export type DurationParts = RequireAtLeastOne<{
+    readonly [Key in DurationPartKey]?: number;
+}>;
 declare const millisecondsTag: unique symbol;
+/** Immutable duration value with conversions, comparisons, and state flags. */
 export type Duration = {
     readonly [millisecondsTag]: number;
     readonly isFinite: boolean;
     readonly isInfinite: boolean;
     readonly isInstant: boolean;
     to(unit: TimeUnit): number;
-    toMilliSeconds(): number;
+    toMilliseconds(): number;
     toSeconds(): number;
     toMinutes(): number;
     toHours(): number;
@@ -30,24 +59,49 @@ export type Duration = {
     greaterThanOrEqual(other: Duration): boolean;
     compare(other: Duration): -1 | 0 | 1;
 };
+/** Creates a duration from a finite numeric value in the provided unit. */
 export declare function duration(value: number, unit: TimeUnit): Duration;
-export declare function milliSeconds(value: number): Duration;
+/** Creates a duration from strict multi-unit parts. */
+export declare function duration(parts: DurationParts): Duration;
+/** Creates a duration from a finite millisecond value. */
+export declare function milliseconds(value: number): Duration;
+/** Creates a duration from a finite second value. */
 export declare function seconds(value: number): Duration;
+/** Creates a duration from a finite minute value. */
 export declare function minutes(value: number): Duration;
+/** Creates a duration from a finite hour value. */
 export declare function hours(value: number): Duration;
+/** Creates a duration from a finite day value. */
 export declare function days(value: number): Duration;
+/** Creates a duration from a finite week value. */
 export declare function weeks(value: number): Duration;
+/** Creates a duration from a finite approximate month value (30 days each). */
 export declare function months(value: number): Duration;
+/** Creates a duration from a finite approximate year value (365.25 days each). */
 export declare function years(value: number): Duration;
+/** Returns the duration between two valid dates. The result may be negative. */
 export declare function between(start: Date, end: Date): Duration;
+/** Returns the duration since a valid start date. The result may be negative. */
 export declare function since(start: Date): Duration;
+/** Adds two durations and preserves the explicit `infinite` sentinel. */
 export declare function add(a: Duration, b: Duration): Duration;
+/** Subtracts one duration from another and rejects undefined `infinite` cases. */
 export declare function subtract(a: Duration, b: Duration): Duration;
+/** Multiplies a duration by a finite scalar. */
 export declare function multiply(a: Duration, b: number): Duration;
+/** Divides a duration by a finite, non-zero scalar. */
 export declare function divide(a: Duration, b: number): Duration;
+/** Returns a new date shifted forward by an exact duration timestamp delta. */
+export declare function addTo(date: Date, duration: Duration): Date;
+/** Returns a new date shifted backward by an exact duration timestamp delta. */
+export declare function subtractFrom(date: Date, duration: Duration): Date;
+/** The explicit non-finite duration sentinel supported by this package. */
 export declare const infinite: Duration;
+/** The zero-length duration constant. */
 export declare const instant: Duration;
+/** Returns `true` when the value is a duration created by this package. */
 export declare function isDuration(value: unknown): value is Duration;
+/** Compares two durations by their normalized millisecond payload. */
 export declare function isEqual(a: Duration, b: Duration): boolean;
 export {};
 //# sourceMappingURL=duration.d.ts.map

package/dist/lib/duration.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"duration.d.ts","sourceRoot":"","sources":["../../src/lib/duration.ts"],"names":[],"mappings":"AAMA,0BAAkB,QAAQ;IACxB,WAAW,IAAA;IACX,MAAM,IAAA;IACN,MAAM,IAAA;IACN,IAAI,IAAA;IACJ,GAAG,IAAA;IACH,IAAI,IAAA;IACJ,KAAK,IAAA;IACL,IAAI,IAAA;CACL;AAED,QAAA,MAAM,eAAe,eAAyB,CAAC;AAE/C,MAAM,MAAM,QAAQ,GAAG;IACrB,QAAQ,CAAC,CAAC,eAAe,CAAC,EAAE,MAAM,CAAC;IACnC,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC;IAC3B,QAAQ,CAAC,UAAU,EAAE,OAAO,CAAC;IAC7B,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC;IAE5B,EAAE,CAAC,IAAI,EAAE,QAAQ,GAAG,MAAM,CAAC;IAC3B,cAAc,IAAI,MAAM,CAAC;IACzB,SAAS,IAAI,MAAM,CAAC;IACpB,SAAS,IAAI,MAAM,CAAC;IACpB,OAAO,IAAI,MAAM,CAAC;IAClB,MAAM,IAAI,MAAM,CAAC;IACjB,OAAO,IAAI,MAAM,CAAC;IAClB,QAAQ,IAAI,MAAM,CAAC;IACnB,OAAO,IAAI,MAAM,CAAC;IAElB,MAAM,CAAC,KAAK,EAAE,QAAQ,GAAG,OAAO,CAAC;IACjC,QAAQ,CAAC,KAAK,EAAE,QAAQ,GAAG,OAAO,CAAC;IACnC,eAAe,CAAC,KAAK,EAAE,QAAQ,GAAG,OAAO,CAAC;IAC1C,WAAW,CAAC,KAAK,EAAE,QAAQ,GAAG,OAAO,CAAC;IACtC,kBAAkB,CAAC,KAAK,EAAE,QAAQ,GAAG,OAAO,CAAC;IAC7C,OAAO,CAAC,KAAK,EAAE,QAAQ,GAAG,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;CACtC,CAAC;AAoFF,wBAAgB,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,QAAQ,GAAG,QAAQ,CAEhE;AAED,wBAAgB,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,QAAQ,CAEpD;AAED,wBAAgB,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,QAAQ,CAE/C;AAED,wBAAgB,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,QAAQ,CAE/C;AAED,wBAAgB,KAAK,CAAC,KAAK,EAAE,MAAM,GAAG,QAAQ,CAE7C;AAED,wBAAgB,IAAI,CAAC,KAAK,EAAE,MAAM,GAAG,QAAQ,CAE5C;AAED,wBAAgB,KAAK,CAAC,KAAK,EAAE,MAAM,GAAG,QAAQ,CAE7C;AAED,wBAAgB,MAAM,CAAC,KAAK,EAAE,MAAM,GAAG,QAAQ,CAE9C;AAED,wBAAgB,KAAK,CAAC,KAAK,EAAE,MAAM,GAAG,QAAQ,CAE7C;AAED,wBAAgB,OAAO,CAAC,KAAK,EAAE,IAAI,EAAE,GAAG,EAAE,IAAI,GAAG,QAAQ,CAExD;AAED,wBAAgB,KAAK,CAAC,KAAK,EAAE,IAAI,GAAG,QAAQ,CAE3C;AAED,wBAAgB,GAAG,CAAC,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,QAAQ,GAAG,QAAQ,CAEtD;AAED,wBAAgB,QAAQ,CAAC,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,QAAQ,GAAG,QAAQ,CAE3D;AAED,wBAAgB,QAAQ,CAAC,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,MAAM,GAAG,QAAQ,CAEzD;AAED,wBAAgB,MAAM,CAAC,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,MAAM,GAAG,QAAQ,CAEvD;AAED,eAAO,MAAM,QAAQ,EAAE,QAAiC,CAAC;AACzD,eAAO,MAAM,OAAO,EAAE,QAA0B,CAAC;AAEjD,wBAAgB,UAAU,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,QAAQ,CAE5D;AAED,wBAAgB,OAAO,CAAC,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,QAAQ,GAAG,OAAO,CAEzD"}
+{"version":3,"file":"duration.d.ts","sourceRoot":"","sources":["../../src/lib/duration.ts"],"names":[],"mappings":"AAEA,QAAA,MAAM,gBAAgB;;;;;;;;;CASZ,CAAC;AAEX,wDAAwD;AACxD,MAAM,MAAM,QAAQ,GAAG,CAAC,OAAO,gBAAgB,CAAC,CAAC,MAAM,OAAO,gBAAgB,CAAC,CAAC;AAEhF;;;;GAIG;AACH,eAAO,MAAM,QAAQ,EAAE;IACrB,QAAQ,EAAE,GAAG,IAAI,MAAM,OAAO,gBAAgB,GAAG,QAAQ;CACvC,CAAC;AAErB,QAAA,MAAM,wBAAwB;;;;;;;;;CASpB,CAAC;AAEX,KAAK,eAAe,GAAG,MAAM,OAAO,wBAAwB,CAAC;AAE7D,KAAK,iBAAiB,CAAC,CAAC,IAAI;KACzB,GAAG,IAAI,MAAM,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;CACnE,CAAC,MAAM,CAAC,CAAC,CAAC;AAMX,kFAAkF;AAClF,MAAM,MAAM,aAAa,GAAG,iBAAiB,CAAC;IAC5C,QAAQ,EAAE,GAAG,IAAI,eAAe,CAAC,CAAC,EAAE,MAAM;CAC3C,CAAC,CAAC;AAEH,QAAA,MAAM,eAAe,eAAyB,CAAC;AAM/C,+EAA+E;AAC/E,MAAM,MAAM,QAAQ,GAAG;IACrB,QAAQ,CAAC,CAAC,eAAe,CAAC,EAAE,MAAM,CAAC;IACnC,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC;IAC3B,QAAQ,CAAC,UAAU,EAAE,OAAO,CAAC;IAC7B,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC;IAE5B,EAAE,CAAC,IAAI,EAAE,QAAQ,GAAG,MAAM,CAAC;IAC3B,cAAc,IAAI,MAAM,CAAC;IACzB,SAAS,IAAI,MAAM,CAAC;IACpB,SAAS,IAAI,MAAM,CAAC;IACpB,OAAO,IAAI,MAAM,CAAC;IAClB,MAAM,IAAI,MAAM,CAAC;IACjB,OAAO,IAAI,MAAM,CAAC;IAClB,QAAQ,IAAI,MAAM,CAAC;IACnB,OAAO,IAAI,MAAM,CAAC;IAElB,MAAM,CAAC,KAAK,EAAE,QAAQ,GAAG,OAAO,CAAC;IACjC,QAAQ,CAAC,KAAK,EAAE,QAAQ,GAAG,OAAO,CAAC;IACnC,eAAe,CAAC,KAAK,EAAE,QAAQ,GAAG,OAAO,CAAC;IAC1C,WAAW,CAAC,KAAK,EAAE,QAAQ,GAAG,OAAO,CAAC;IACtC,kBAAkB,CAAC,KAAK,EAAE,QAAQ,GAAG,OAAO,CAAC;IAC7C,OAAO,CAAC,KAAK,EAAE,QAAQ,GAAG,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;CACtC,CAAC;AA4KF,2EAA2E;AAC3E,wBAAgB,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,QAAQ,GAAG,QAAQ,CAAC;AAElE,uDAAuD;AACvD,wBAAgB,QAAQ,CAAC,KAAK,EAAE,aAAa,GAAG,QAAQ,CAAC;AAazD,0DAA0D;AAC1D,wBAAgB,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,QAAQ,CAEpD;AAED,qDAAqD;AACrD,wBAAgB,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,QAAQ,CAE/C;AAED,qDAAqD;AACrD,wBAAgB,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,QAAQ,CAE/C;AAED,mDAAmD;AACnD,wBAAgB,KAAK,CAAC,KAAK,EAAE,MAAM,GAAG,QAAQ,CAE7C;AAED,kDAAkD;AAClD,wBAAgB,IAAI,CAAC,KAAK,EAAE,MAAM,GAAG,QAAQ,CAE5C;AAED,mDAAmD;AACnD,wBAAgB,KAAK,CAAC,KAAK,EAAE,MAAM,GAAG,QAAQ,CAE7C;AAED,+EAA+E;AAC/E,wBAAgB,MAAM,CAAC,KAAK,EAAE,MAAM,GAAG,QAAQ,CAE9C;AAED,kFAAkF;AAClF,wBAAgB,KAAK,CAAC,KAAK,EAAE,MAAM,GAAG,QAAQ,CAE7C;AAED,gFAAgF;AAChF,wBAAgB,OAAO,CAAC,KAAK,EAAE,IAAI,EAAE,GAAG,EAAE,IAAI,GAAG,QAAQ,CAKxD;AAED,iFAAiF;AACjF,wBAAgB,KAAK,CAAC,KAAK,EAAE,IAAI,GAAG,QAAQ,CAE3C;AAUD,yEAAyE;AACzE,wBAAgB,GAAG,CAAC,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,QAAQ,GAAG,QAAQ,CAMtD;AAED,kFAAkF;AAClF,wBAAgB,QAAQ,CAAC,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,QAAQ,GAAG,QAAQ,CAc3D;AAED,gDAAgD;AAChD,wBAAgB,QAAQ,CAAC,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,MAAM,GAAG,QAAQ,CAczD;AAED,uDAAuD;AACvD,wBAAgB,MAAM,CAAC,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,MAAM,GAAG,QAAQ,CAevD;AAED,+EAA+E;AAC/E,wBAAgB,KAAK,CAAC,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,GAAG,IAAI,CAK1D;AAED,gFAAgF;AAChF,wBAAgB,YAAY,CAAC,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,GAAG,IAAI,CAKjE;AAED,2EAA2E;AAC3E,eAAO,MAAM,QAAQ,EAAE,QAA4D,CAAC;AAEpF,yCAAyC;AACzC,eAAO,MAAM,OAAO,EAAE,QAA0B,CAAC;AAEjD,2EAA2E;AAC3E,wBAAgB,UAAU,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,QAAQ,CAE5D;AAED,sEAAsE;AACtE,wBAAgB,OAAO,CAAC,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,QAAQ,GAAG,OAAO,CAEzD"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pvorona/duration",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "license": "MIT",
   "type": "module",
   "main": "./dist/index.js",
@@ -9,7 +9,6 @@
   "exports": {
     "./package.json": "./package.json",
     ".": {
-      "@pvorona/source": "./src/index.ts",
       "types": "./dist/index.d.ts",
       "import": "./dist/index.js",
       "default": "./dist/index.js"
@@ -19,10 +18,15 @@
     "dist",
     "!**/*.tsbuildinfo"
   ],
+  "scripts": {
+    "check-consumer-types": "node ./scripts/check-consumer-types.mjs",
+    "check-package-surface": "node ./scripts/check-package-surface.mjs",
+    "prepublishOnly": "npm run check-consumer-types && npm run check-package-surface"
+  },
   "publishConfig": {
     "access": "public"
   },
   "dependencies": {
-    "@pvorona/assert": "~0.0.2"
+    "@pvorona/assert": "~0.1.0"
   }
 }