effect 3.8.4 → 3.9.0

package/src/Duration.ts

@@ -6,7 +6,7 @@ import type * as equivalence from "./Equivalence.js"
 import { dual } from "./Function.js"
 import * as Hash from "./Hash.js"
 import type { Inspectable } from "./Inspectable.js"
-import { NodeInspectSymbol } from "./Inspectable.js"
+import { DenoInspectSymbol, NodeInspectSymbol } from "./Inspectable.js"
 import * as Option from "./Option.js"
 import * as order from "./Order.js"
 import type { Pipeable } from "./Pipeable.js"
@@ -160,6 +160,9 @@ const DurationProto: Omit<Duration, "value"> = {
         return { _id: "Duration", _tag: "Infinity" }
     }
   },
+  [DenoInspectSymbol]() {
+    return this.toJSON()
+  },
   [NodeInspectSymbol]() {
     return this.toJSON()
   },
@@ -405,12 +408,20 @@ export const toHrTime = (self: DurationInput): [seconds: number, nanos: number]
  * @category pattern matching
  */
 export const match: {
+  /**
+   * @since 2.0.0
+   * @category pattern matching
+   */
   <A, B>(
     options: {
       readonly onMillis: (millis: number) => A
       readonly onNanos: (nanos: bigint) => B
     }
   ): (self: DurationInput) => A | B
+  /**
+   * @since 2.0.0
+   * @category pattern matching
+   */
   <A, B>(
     self: DurationInput,
     options: {
@@ -441,6 +452,10 @@ export const match: {
  * @category pattern matching
  */
 export const matchWith: {
+  /**
+   * @since 2.0.0
+   * @category pattern matching
+   */
   <A, B>(
     that: DurationInput,
     options: {
@@ -448,6 +463,10 @@ export const matchWith: {
       readonly onNanos: (self: bigint, that: bigint) => B
     }
   ): (self: DurationInput) => A | B
+  /**
+   * @since 2.0.0
+   * @category pattern matching
+   */
   <A, B>(
     self: DurationInput,
     that: DurationInput,
@@ -505,14 +524,31 @@ export const Order: order.Order<Duration> = order.make((self, that) =>
  * @since 2.0.0
  */
 export const between: {
-  (options: {
-    minimum: DurationInput
-    maximum: DurationInput
-  }): (self: DurationInput) => boolean
-  (self: DurationInput, options: {
-    minimum: DurationInput
-    maximum: DurationInput
-  }): boolean
+  /**
+   * Checks if a `Duration` is between a `minimum` and `maximum` value.
+   *
+   * @category predicates
+   * @since 2.0.0
+   */
+  (
+    options: {
+      minimum: DurationInput
+      maximum: DurationInput
+    }
+  ): (self: DurationInput) => boolean
+  /**
+   * Checks if a `Duration` is between a `minimum` and `maximum` value.
+   *
+   * @category predicates
+   * @since 2.0.0
+   */
+  (
+    self: DurationInput,
+    options: {
+      minimum: DurationInput
+      maximum: DurationInput
+    }
+  ): boolean
 } = order.between(order.mapInput(Order, decode))
 
 /**
@@ -531,7 +567,13 @@ const _min = order.min(Order)
  * @since 2.0.0
  */
 export const min: {
+  /**
+   * @since 2.0.0
+   */
   (that: DurationInput): (self: DurationInput) => Duration
+  /**
+   * @since 2.0.0
+   */
   (self: DurationInput, that: DurationInput): Duration
 } = dual(2, (self: DurationInput, that: DurationInput): Duration => _min(decode(self), decode(that)))
 
@@ -542,7 +584,15 @@ const _max = order.max(Order)
  * @category order
  */
 export const max: {
+  /**
+   * @since 2.0.0
+   * @category order
+   */
   (that: DurationInput): (self: DurationInput) => Duration
+  /**
+   * @since 2.0.0
+   * @category order
+   */
   (self: DurationInput, that: DurationInput): Duration
 } = dual(2, (self: DurationInput, that: DurationInput): Duration => _max(decode(self), decode(that)))
 
@@ -553,14 +603,27 @@ const _clamp = order.clamp(Order)
  * @category order
  */
 export const clamp: {
-  (options: {
-    minimum: DurationInput
-    maximum: DurationInput
-  }): (self: DurationInput) => Duration
-  (self: DurationInput, options: {
-    minimum: DurationInput
-    maximum: DurationInput
-  }): Duration
+  /**
+   * @since 2.0.0
+   * @category order
+   */
+  (
+    options: {
+      minimum: DurationInput
+      maximum: DurationInput
+    }
+  ): (self: DurationInput) => Duration
+  /**
+   * @since 2.0.0
+   * @category order
+   */
+  (
+    self: DurationInput,
+    options: {
+      minimum: DurationInput
+      maximum: DurationInput
+    }
+  ): Duration
 } = dual(
   2,
   (self: DurationInput, options: {
@@ -578,7 +641,15 @@ export const clamp: {
  * @category math
  */
 export const divide: {
+  /**
+   * @since 2.4.19
+   * @category math
+   */
   (by: number): (self: DurationInput) => Option.Option<Duration>
+  /**
+   * @since 2.4.19
+   * @category math
+   */
   (self: DurationInput, by: number): Option.Option<Duration>
 } = dual(
   2,
@@ -608,7 +679,15 @@ export const divide: {
  * @category math
  */
 export const unsafeDivide: {
+  /**
+   * @since 2.4.19
+   * @category math
+   */
   (by: number): (self: DurationInput) => Duration
+  /**
+   * @since 2.4.19
+   * @category math
+   */
   (self: DurationInput, by: number): Duration
 } = dual(
   2,
@@ -631,7 +710,15 @@ export const unsafeDivide: {
  * @category math
  */
 export const times: {
+  /**
+   * @since 2.0.0
+   * @category math
+   */
   (times: number): (self: DurationInput) => Duration
+  /**
+   * @since 2.0.0
+   * @category math
+   */
   (self: DurationInput, times: number): Duration
 } = dual(
   2,
@@ -647,7 +734,15 @@ export const times: {
  * @category math
  */
 export const subtract: {
+  /**
+   * @since 2.0.0
+   * @category math
+   */
   (that: DurationInput): (self: DurationInput) => Duration
+  /**
+   * @since 2.0.0
+   * @category math
+   */
   (self: DurationInput, that: DurationInput): Duration
 } = dual(
   2,
@@ -663,7 +758,15 @@ export const subtract: {
  * @category math
  */
 export const sum: {
+  /**
+   * @since 2.0.0
+   * @category math
+   */
   (that: DurationInput): (self: DurationInput) => Duration
+  /**
+   * @since 2.0.0
+   * @category math
+   */
   (self: DurationInput, that: DurationInput): Duration
 } = dual(
   2,
@@ -679,7 +782,15 @@ export const sum: {
  * @category predicates
  */
 export const lessThan: {
+  /**
+   * @since 2.0.0
+   * @category predicates
+   */
   (that: DurationInput): (self: DurationInput) => boolean
+  /**
+   * @since 2.0.0
+   * @category predicates
+   */
   (self: DurationInput, that: DurationInput): boolean
 } = dual(
   2,
@@ -695,7 +806,15 @@ export const lessThan: {
  * @category predicates
  */
 export const lessThanOrEqualTo: {
+  /**
+   * @since 2.0.0
+   * @category predicates
+   */
   (that: DurationInput): (self: DurationInput) => boolean
+  /**
+   * @since 2.0.0
+   * @category predicates
+   */
   (self: DurationInput, that: DurationInput): boolean
 } = dual(
   2,
@@ -711,7 +830,15 @@ export const lessThanOrEqualTo: {
  * @category predicates
  */
 export const greaterThan: {
+  /**
+   * @since 2.0.0
+   * @category predicates
+   */
   (that: DurationInput): (self: DurationInput) => boolean
+  /**
+   * @since 2.0.0
+   * @category predicates
+   */
   (self: DurationInput, that: DurationInput): boolean
 } = dual(
   2,
@@ -727,7 +854,15 @@ export const greaterThan: {
  * @category predicates
  */
 export const greaterThanOrEqualTo: {
+  /**
+   * @since 2.0.0
+   * @category predicates
+   */
   (that: DurationInput): (self: DurationInput) => boolean
+  /**
+   * @since 2.0.0
+   * @category predicates
+   */
   (self: DurationInput, that: DurationInput): boolean
 } = dual(
   2,
@@ -743,7 +878,15 @@ export const greaterThanOrEqualTo: {
  * @category predicates
  */
 export const equals: {
+  /**
+   * @since 2.0.0
+   * @category predicates
+   */
   (that: DurationInput): (self: DurationInput) => boolean
+  /**
+   * @since 2.0.0
+   * @category predicates
+   */
   (self: DurationInput, that: DurationInput): boolean
 } = dual(2, (self: DurationInput, that: DurationInput): boolean => Equivalence(decode(self), decode(that)))