effect 3.8.4 → 3.9.0

package/src/HashSet.ts

@@ -30,7 +30,15 @@ export interface HashSet<out A> extends Iterable<A>, Equal, Pipeable, Inspectabl
  * @category refinements
  */
 export const isHashSet: {
+  /**
+   * @since 2.0.0
+   * @category refinements
+   */
   <A>(u: Iterable<A>): u is HashSet<A>
+  /**
+   * @since 2.0.0
+   * @category refinements
+   */
   (u: unknown): u is HashSet<unknown>
 } = HS.isHashSet
 
@@ -65,7 +73,19 @@ export const make: <As extends ReadonlyArray<any>>(...elements: As) => HashSet<A
  * @category elements
  */
 export const has: {
+  /**
+   * Checks if the specified value exists in the `HashSet`.
+   *
+   * @since 2.0.0
+   * @category elements
+   */
   <A>(value: A): (self: HashSet<A>) => boolean
+  /**
+   * Checks if the specified value exists in the `HashSet`.
+   *
+   * @since 2.0.0
+   * @category elements
+   */
   <A>(self: HashSet<A>, value: A): boolean
 } = HS.has
 
@@ -76,7 +96,19 @@ export const has: {
  * @category elements
  */
 export const some: {
+  /**
+   * Check if a predicate holds true for some `HashSet` element.
+   *
+   * @since 2.0.0
+   * @category elements
+   */
   <A>(f: Predicate<A>): (self: HashSet<A>) => boolean
+  /**
+   * Check if a predicate holds true for some `HashSet` element.
+   *
+   * @since 2.0.0
+   * @category elements
+   */
   <A>(self: HashSet<A>, f: Predicate<A>): boolean
 } = HS.some
 
@@ -87,9 +119,33 @@ export const some: {
  * @category elements
  */
 export const every: {
+  /**
+   * Check if a predicate holds true for every `HashSet` element.
+   *
+   * @since 2.0.0
+   * @category elements
+   */
   <A, B extends A>(refinement: Refinement<NoInfer<A>, B>): (self: HashSet<A>) => self is HashSet<B>
+  /**
+   * Check if a predicate holds true for every `HashSet` element.
+   *
+   * @since 2.0.0
+   * @category elements
+   */
   <A>(predicate: Predicate<A>): (self: HashSet<A>) => boolean
+  /**
+   * Check if a predicate holds true for every `HashSet` element.
+   *
+   * @since 2.0.0
+   * @category elements
+   */
   <A, B extends A>(self: HashSet<A>, refinement: Refinement<A, B>): self is HashSet<B>
+  /**
+   * Check if a predicate holds true for every `HashSet` element.
+   *
+   * @since 2.0.0
+   * @category elements
+   */
   <A>(self: HashSet<A>, predicate: Predicate<A>): boolean
 } = HS.every
 
@@ -103,7 +159,25 @@ export const every: {
  * @category elements
  */
 export const isSubset: {
+  /**
+   * Returns `true` if and only if every element in the this `HashSet` is an
+   * element of the second set,
+   *
+   * **NOTE**: the hash and equal of both sets must be the same.
+   *
+   * @since 2.0.0
+   * @category elements
+   */
   <A>(that: HashSet<A>): (self: HashSet<A>) => boolean
+  /**
+   * Returns `true` if and only if every element in the this `HashSet` is an
+   * element of the second set,
+   *
+   * **NOTE**: the hash and equal of both sets must be the same.
+   *
+   * @since 2.0.0
+   * @category elements
+   */
   <A>(self: HashSet<A>, that: HashSet<A>): boolean
 } = HS.isSubset
 
@@ -143,7 +217,17 @@ export const endMutation: <A>(self: HashSet<A>) => HashSet<A> = HS.endMutation
  * @since 2.0.0
  */
 export const mutate: {
+  /**
+   * Mutates the `HashSet` within the context of the provided function.
+   *
+   * @since 2.0.0
+   */
   <A>(f: (set: HashSet<A>) => void): (self: HashSet<A>) => HashSet<A>
+  /**
+   * Mutates the `HashSet` within the context of the provided function.
+   *
+   * @since 2.0.0
+   */
   <A>(self: HashSet<A>, f: (set: HashSet<A>) => void): HashSet<A>
 } = HS.mutate
 
@@ -153,7 +237,17 @@ export const mutate: {
  * @since 2.0.0
  */
 export const add: {
+  /**
+   * Adds a value to the `HashSet`.
+   *
+   * @since 2.0.0
+   */
   <A>(value: A): (self: HashSet<A>) => HashSet<A>
+  /**
+   * Adds a value to the `HashSet`.
+   *
+   * @since 2.0.0
+   */
   <A>(self: HashSet<A>, value: A): HashSet<A>
 } = HS.add
 
@@ -163,7 +257,17 @@ export const add: {
  * @since 2.0.0
  */
 export const remove: {
+  /**
+   * Removes a value from the `HashSet`.
+   *
+   * @since 2.0.0
+   */
   <A>(value: A): (self: HashSet<A>) => HashSet<A>
+  /**
+   * Removes a value from the `HashSet`.
+   *
+   * @since 2.0.0
+   */
   <A>(self: HashSet<A>, value: A): HashSet<A>
 } = HS.remove
 
@@ -177,7 +281,25 @@ export const remove: {
  * @since 2.0.0
  */
 export const difference: {
+  /**
+   * Computes the set difference between this `HashSet` and the specified
+   * `Iterable<A>`.
+   *
+   * **NOTE**: the hash and equal of the values in both the set and the iterable
+   * must be the same.
+   *
+   * @since 2.0.0
+   */
   <A>(that: Iterable<A>): (self: HashSet<A>) => HashSet<A>
+  /**
+   * Computes the set difference between this `HashSet` and the specified
+   * `Iterable<A>`.
+   *
+   * **NOTE**: the hash and equal of the values in both the set and the iterable
+   * must be the same.
+   *
+   * @since 2.0.0
+   */
   <A>(self: HashSet<A>, that: Iterable<A>): HashSet<A>
 } = HS.difference
 
@@ -191,7 +313,25 @@ export const difference: {
  * @since 2.0.0
  */
 export const intersection: {
+  /**
+   * Returns a `HashSet` of values which are present in both this set and that
+   * `Iterable<A>`.
+   *
+   * **NOTE**: the hash and equal of the values in both the set and the iterable
+   * must be the same.
+   *
+   * @since 2.0.0
+   */
   <A>(that: Iterable<A>): (self: HashSet<A>) => HashSet<A>
+  /**
+   * Returns a `HashSet` of values which are present in both this set and that
+   * `Iterable<A>`.
+   *
+   * **NOTE**: the hash and equal of the values in both the set and the iterable
+   * must be the same.
+   *
+   * @since 2.0.0
+   */
   <A>(self: HashSet<A>, that: Iterable<A>): HashSet<A>
 } = HS.intersection
 
@@ -205,7 +345,25 @@ export const intersection: {
  * @since 2.0.0
  */
 export const union: {
+  /**
+   * Computes the set union `(`self` + `that`)` between this `HashSet` and the
+   * specified `Iterable<A>`.
+   *
+   * **NOTE**: the hash and equal of the values in both the set and the iterable
+   * must be the same.
+   *
+   * @since 2.0.0
+   */
   <A>(that: Iterable<A>): (self: HashSet<A>) => HashSet<A>
+  /**
+   * Computes the set union `(`self` + `that`)` between this `HashSet` and the
+   * specified `Iterable<A>`.
+   *
+   * **NOTE**: the hash and equal of the values in both the set and the iterable
+   * must be the same.
+   *
+   * @since 2.0.0
+   */
   <A>(self: HashSet<A>, that: Iterable<A>): HashSet<A>
 } = HS.union
 
@@ -217,7 +375,21 @@ export const union: {
  * @since 2.0.0
  */
 export const toggle: {
+  /**
+   * Checks if a value is present in the `HashSet`. If it is present, the value
+   * will be removed from the `HashSet`, otherwise the value will be added to the
+   * `HashSet`.
+   *
+   * @since 2.0.0
+   */
   <A>(value: A): (self: HashSet<A>) => HashSet<A>
+  /**
+   * Checks if a value is present in the `HashSet`. If it is present, the value
+   * will be removed from the `HashSet`, otherwise the value will be added to the
+   * `HashSet`.
+   *
+   * @since 2.0.0
+   */
   <A>(self: HashSet<A>, value: A): HashSet<A>
 } = HS.toggle
 
@@ -228,7 +400,19 @@ export const toggle: {
  * @category mapping
  */
 export const map: {
+  /**
+   * Maps over the values of the `HashSet` using the specified function.
+   *
+   * @since 2.0.0
+   * @category mapping
+   */
   <A, B>(f: (a: A) => B): (self: HashSet<A>) => HashSet<B>
+  /**
+   * Maps over the values of the `HashSet` using the specified function.
+   *
+   * @since 2.0.0
+   * @category mapping
+   */
   <A, B>(self: HashSet<A>, f: (a: A) => B): HashSet<B>
 } = HS.map
 
@@ -239,7 +423,19 @@ export const map: {
  * @category sequencing
  */
 export const flatMap: {
+  /**
+   * Chains over the values of the `HashSet` using the specified function.
+   *
+   * @since 2.0.0
+   * @category sequencing
+   */
   <A, B>(f: (a: A) => Iterable<B>): (self: HashSet<A>) => HashSet<B>
+  /**
+   * Chains over the values of the `HashSet` using the specified function.
+   *
+   * @since 2.0.0
+   * @category sequencing
+   */
   <A, B>(self: HashSet<A>, f: (a: A) => Iterable<B>): HashSet<B>
 } = HS.flatMap
 
@@ -250,7 +446,19 @@ export const flatMap: {
  * @category traversing
  */
 export const forEach: {
+  /**
+   * Applies the specified function to the values of the `HashSet`.
+   *
+   * @since 2.0.0
+   * @category traversing
+   */
   <A>(f: (value: A) => void): (self: HashSet<A>) => void
+  /**
+   * Applies the specified function to the values of the `HashSet`.
+   *
+   * @since 2.0.0
+   * @category traversing
+   */
   <A>(self: HashSet<A>, f: (value: A) => void): void
 } = HS.forEach
 
@@ -261,7 +469,19 @@ export const forEach: {
  * @category folding
  */
 export const reduce: {
+  /**
+   * Reduces the specified state over the values of the `HashSet`.
+   *
+   * @since 2.0.0
+   * @category folding
+   */
   <A, Z>(zero: Z, f: (accumulator: Z, value: A) => Z): (self: HashSet<A>) => Z
+  /**
+   * Reduces the specified state over the values of the `HashSet`.
+   *
+   * @since 2.0.0
+   * @category folding
+   */
   <A, Z>(self: HashSet<A>, zero: Z, f: (accumulator: Z, value: A) => Z): Z
 } = HS.reduce
 
@@ -272,9 +492,33 @@ export const reduce: {
  * @category filtering
  */
 export const filter: {
+  /**
+   * Filters values out of a `HashSet` using the specified predicate.
+   *
+   * @since 2.0.0
+   * @category filtering
+   */
   <A, B extends A>(refinement: Refinement<NoInfer<A>, B>): (self: HashSet<A>) => HashSet<B>
+  /**
+   * Filters values out of a `HashSet` using the specified predicate.
+   *
+   * @since 2.0.0
+   * @category filtering
+   */
   <A>(predicate: Predicate<NoInfer<A>>): (self: HashSet<A>) => HashSet<A>
+  /**
+   * Filters values out of a `HashSet` using the specified predicate.
+   *
+   * @since 2.0.0
+   * @category filtering
+   */
   <A, B extends A>(self: HashSet<A>, refinement: Refinement<A, B>): HashSet<B>
+  /**
+   * Filters values out of a `HashSet` using the specified predicate.
+   *
+   * @since 2.0.0
+   * @category filtering
+   */
   <A>(self: HashSet<A>, predicate: Predicate<A>): HashSet<A>
 } = HS.filter
 
@@ -289,13 +533,53 @@ export const filter: {
  * @category partitioning
  */
 export const partition: {
+  /**
+   * Partition the values of a `HashSet` using the specified predicate.
+   *
+   * If a value matches the predicate, it will be placed into the `HashSet` on the
+   * right side of the resulting `Tuple`, otherwise the value will be placed into
+   * the left side.
+   *
+   * @since 2.0.0
+   * @category partitioning
+   */
   <A, B extends A>(
     refinement: Refinement<NoInfer<A>, B>
   ): (self: HashSet<A>) => [excluded: HashSet<Exclude<A, B>>, satisfying: HashSet<B>]
+  /**
+   * Partition the values of a `HashSet` using the specified predicate.
+   *
+   * If a value matches the predicate, it will be placed into the `HashSet` on the
+   * right side of the resulting `Tuple`, otherwise the value will be placed into
+   * the left side.
+   *
+   * @since 2.0.0
+   * @category partitioning
+   */
   <A>(predicate: Predicate<NoInfer<A>>): (self: HashSet<A>) => [excluded: HashSet<A>, satisfying: HashSet<A>]
+  /**
+   * Partition the values of a `HashSet` using the specified predicate.
+   *
+   * If a value matches the predicate, it will be placed into the `HashSet` on the
+   * right side of the resulting `Tuple`, otherwise the value will be placed into
+   * the left side.
+   *
+   * @since 2.0.0
+   * @category partitioning
+   */
   <A, B extends A>(
     self: HashSet<A>,
     refinement: Refinement<A, B>
   ): [excluded: HashSet<Exclude<A, B>>, satisfying: HashSet<B>]
+  /**
+   * Partition the values of a `HashSet` using the specified predicate.
+   *
+   * If a value matches the predicate, it will be placed into the `HashSet` on the
+   * right side of the resulting `Tuple`, otherwise the value will be placed into
+   * the left side.
+   *
+   * @since 2.0.0
+   * @category partitioning
+   */
   <A>(self: HashSet<A>, predicate: Predicate<A>): [excluded: HashSet<A>, satisfying: HashSet<A>]
 } = HS.partition

package/src/Inspectable.ts

@@ -16,6 +16,18 @@ export const NodeInspectSymbol = Symbol.for("nodejs.util.inspect.custom")
  */
 export type NodeInspectSymbol = typeof NodeInspectSymbol
 
+/**
+ * @since 3.9.0
+ * @category symbols
+ */
+export const DenoInspectSymbol = Symbol.for("Deno.customInspect")
+
+/**
+ * @since 3.9.0
+ * @category symbols
+ */
+export type DenoInspectSymbol = typeof DenoInspectSymbol
+
 /**
  * @since 2.0.0
  * @category models
@@ -24,6 +36,7 @@ export interface Inspectable {
   toString(): string
   toJSON(): unknown
   [NodeInspectSymbol](): unknown
+  [DenoInspectSymbol](): unknown
 }
 
 /**
@@ -56,6 +69,9 @@ export const BaseProto: Inspectable = {
   [NodeInspectSymbol]() {
     return this.toJSON()
   },
+  [DenoInspectSymbol]() {
+    return this.toJSON()
+  },
   toString() {
     return format(this.toJSON())
   }
@@ -75,6 +91,12 @@ export abstract class Class {
   [NodeInspectSymbol]() {
     return this.toJSON()
   }
+  /**
+   * @since 3.9.0
+   */
+  [DenoInspectSymbol]() {
+    return this.toJSON()
+  }
   /**
    * @since 2.0.0
    */