effect 4.0.0-beta.67 → 4.0.0-beta.68

package/src/HashRing.ts

@@ -76,8 +76,8 @@ const TypeId = "~effect/cluster/HashRing" as const
  * Nodes are identified by their `PrimaryKey` value and can be iterated from the
  * ring.
  *
- * @category Models
- * @since 4.0.0
+ * @category models
+ * @since 3.19.0
  */
 export interface HashRing<A extends PrimaryKey.PrimaryKey> extends Pipeable, Iterable<A> {
   readonly [TypeId]: typeof TypeId
@@ -90,8 +90,8 @@ export interface HashRing<A extends PrimaryKey.PrimaryKey> extends Pipeable, Ite
 /**
  * Checks whether a value is a `HashRing`.
  *
- * @category Guards
- * @since 4.0.0
+ * @category guards
+ * @since 3.19.0
  */
 export const isHashRing = (u: unknown): u is HashRing<any> => hasProperty(u, TypeId)
 
@@ -101,8 +101,8 @@ export const isHashRing = (u: unknown): u is HashRing<any> => hasProperty(u, Typ
  * `baseWeight` controls how many virtual points are added for a node with
  * weight `1`; it defaults to `128` and is clamped to at least `1`.
  *
- * @category Constructors
- * @since 4.0.0
+ * @category constructors
+ * @since 3.19.0
  */
 export const make = <A extends PrimaryKey.PrimaryKey>(options?: {
   readonly baseWeight?: number | undefined
@@ -134,16 +134,16 @@ const Proto = {
  * Add new nodes to the ring. If a node already exists in the ring, it
  * will be updated. For example, you can use this to update the node's weight.
  *
- * @category Combinators
- * @since 4.0.0
+ * @category combinators
+ * @since 3.19.0
  */
 export const addMany: {
   /**
    * Add new nodes to the ring. If a node already exists in the ring, it
    * will be updated. For example, you can use this to update the node's weight.
    *
-   * @category Combinators
-   * @since 4.0.0
+   * @category combinators
+   * @since 3.19.0
    */
   <A extends PrimaryKey.PrimaryKey>(
     nodes: Iterable<A>,
@@ -155,8 +155,8 @@ export const addMany: {
    * Add new nodes to the ring. If a node already exists in the ring, it
    * will be updated. For example, you can use this to update the node's weight.
    *
-   * @category Combinators
-   * @since 4.0.0
+   * @category combinators
+   * @since 3.19.0
    */
   <A extends PrimaryKey.PrimaryKey>(
     self: HashRing<A>,
@@ -214,16 +214,16 @@ function addNodesToRing<A extends PrimaryKey.PrimaryKey>(self: HashRing<A>, keys
  * Add a new node to the ring. If the node already exists in the ring, it
  * will be updated. For example, you can use this to update the node's weight.
  *
- * @category Combinators
- * @since 4.0.0
+ * @category combinators
+ * @since 3.19.0
  */
 export const add: {
   /**
    * Add a new node to the ring. If the node already exists in the ring, it
    * will be updated. For example, you can use this to update the node's weight.
    *
-   * @category Combinators
-   * @since 4.0.0
+   * @category combinators
+   * @since 3.19.0
    */
   <A extends PrimaryKey.PrimaryKey>(
     node: A,
@@ -235,8 +235,8 @@ export const add: {
    * Add a new node to the ring. If the node already exists in the ring, it
    * will be updated. For example, you can use this to update the node's weight.
    *
-   * @category Combinators
-   * @since 4.0.0
+   * @category combinators
+   * @since 3.19.0
    */
   <A extends PrimaryKey.PrimaryKey>(
     self: HashRing<A>,
@@ -252,22 +252,22 @@ export const add: {
 /**
  * Removes the node from the ring. No-op's if the node does not exist.
  *
- * @category Combinators
- * @since 4.0.0
+ * @category combinators
+ * @since 3.19.0
  */
 export const remove: {
   /**
    * Removes the node from the ring. No-op's if the node does not exist.
    *
-   * @category Combinators
-   * @since 4.0.0
+   * @category combinators
+   * @since 3.19.0
    */
   <A extends PrimaryKey.PrimaryKey>(node: A): (self: HashRing<A>) => HashRing<A>
   /**
    * Removes the node from the ring. No-op's if the node does not exist.
    *
-   * @category Combinators
-   * @since 4.0.0
+   * @category combinators
+   * @since 3.19.0
    */
   <A extends PrimaryKey.PrimaryKey>(self: HashRing<A>, node: A): HashRing<A>
 } = dual(2, <A extends PrimaryKey.PrimaryKey>(self: HashRing<A>, node: A): HashRing<A> => {
@@ -284,22 +284,22 @@ export const remove: {
 /**
  * Checks whether the ring contains a node with the same `PrimaryKey` value.
  *
- * @category Combinators
- * @since 4.0.0
+ * @category combinators
+ * @since 3.19.0
  */
 export const has: {
   /**
    * Checks whether the ring contains a node with the same `PrimaryKey` value.
    *
-   * @category Combinators
-   * @since 4.0.0
+   * @category combinators
+   * @since 3.19.0
    */
   <A extends PrimaryKey.PrimaryKey>(node: A): (self: HashRing<A>) => boolean
   /**
    * Checks whether the ring contains a node with the same `PrimaryKey` value.
    *
-   * @category Combinators
-   * @since 4.0.0
+   * @category combinators
+   * @since 3.19.0
    */
   <A extends PrimaryKey.PrimaryKey>(self: HashRing<A>, node: A): boolean
 } = dual(
@@ -311,8 +311,8 @@ export const has: {
  * Gets the node which should handle the given input. Returns undefined if
  * the hashring has no elements with weight.
  *
- * @category Combinators
- * @since 4.0.0
+ * @category combinators
+ * @since 3.19.0
  */
 export const get = <A extends PrimaryKey.PrimaryKey>(self: HashRing<A>, input: string): A | undefined => {
   if (self.ring.length === 0) {
@@ -328,8 +328,8 @@ export const get = <A extends PrimaryKey.PrimaryKey>(self: HashRing<A>, input: s
  * balance the number of shards allocated to each node. Returns undefined if
  * the hashring has no elements with weight.
  *
- * @category Combinators
- * @since 4.0.0
+ * @category combinators
+ * @since 3.19.0
  */
 export const getShards = <A extends PrimaryKey.PrimaryKey>(self: HashRing<A>, count: number): Array<A> | undefined => {
   if (self.ring.length === 0) {

package/src/HashSet.ts

@@ -56,7 +56,7 @@ const TypeId = internal.HashSetTypeId
  * **Example** (Creating and updating a HashSet)
  *
  * ```ts
- * import * as HashSet from "effect/HashSet"
+ * import { HashSet } from "effect"
  *
  * // Create a HashSet
  * const set = HashSet.make("apple", "banana", "cherry")
@@ -88,7 +88,7 @@ export interface HashSet<out Value> extends Iterable<Value>, Equal, Pipeable, In
  * **Example** (Extracting value types from a HashSet)
  *
  * ```ts
- * import * as HashSet from "effect/HashSet"
+ * import { HashSet } from "effect"
  *
  * // Create a concrete HashSet for type extraction
  * const fruits = HashSet.make("apple", "banana", "cherry")
@@ -102,7 +102,6 @@ export interface HashSet<out Value> extends Iterable<Value>, Equal, Pipeable, In
  * }
  * ```
  *
- * @category namespace
  * @since 2.0.0
  */
 export declare namespace HashSet {
@@ -114,7 +113,7 @@ export declare namespace HashSet {
    * **Example** (Extracting a HashSet value type)
    *
    * ```ts
-   * import * as HashSet from "effect/HashSet"
+   * import { HashSet } from "effect"
    *
    * const numbers = HashSet.make(1, 2, 3, 4, 5)
    *
@@ -125,7 +124,7 @@ export declare namespace HashSet {
    * ```
    *
    * @category type-level
-   * @since 2.0.0
+   * @since 4.0.0
    */
   export type Value<T> = T extends HashSet<infer V> ? V : never
 }
@@ -136,7 +135,7 @@ export declare namespace HashSet {
  * **Example** (Creating an empty HashSet)
  *
  * ```ts
- * import * as HashSet from "effect/HashSet"
+ * import { HashSet } from "effect"
  *
  * const set = HashSet.empty<string>()
  *
@@ -159,7 +158,7 @@ export const empty: <V = never>() => HashSet<V> = internal.empty
  * **Example** (Creating a HashSet from values)
  *
  * ```ts
- * import * as HashSet from "effect/HashSet"
+ * import { HashSet } from "effect"
  *
  * const fruits = HashSet.make("apple", "banana", "cherry")
  * console.log(HashSet.size(fruits)) // 3
@@ -184,7 +183,7 @@ export const make: <Values extends ReadonlyArray<any>>(
  * **Example** (Creating a HashSet from an iterable)
  *
  * ```ts
- * import * as HashSet from "effect/HashSet"
+ * import { HashSet } from "effect"
  *
  * const fromArray = HashSet.fromIterable(["a", "b", "c", "b", "a"])
  * console.log(HashSet.size(fromArray)) // 3
@@ -207,7 +206,7 @@ export const fromIterable: <V>(values: Iterable<V>) => HashSet<V> = internal.fro
  * **Example** (Checking for a HashSet)
  *
  * ```ts
- * import * as HashSet from "effect/HashSet"
+ * import { HashSet } from "effect"
  *
  * const set = HashSet.make(1, 2, 3)
  * const array = [1, 2, 3]
@@ -227,7 +226,7 @@ export const isHashSet: {
    * **Example** (Checking for a HashSet)
    *
    * ```ts
-   * import * as HashSet from "effect/HashSet"
+   * import { HashSet } from "effect"
    *
    * const set = HashSet.make(1, 2, 3)
    * const array = [1, 2, 3]
@@ -247,7 +246,7 @@ export const isHashSet: {
    * **Example** (Checking for a HashSet)
    *
    * ```ts
-   * import * as HashSet from "effect/HashSet"
+   * import { HashSet } from "effect"
    *
    * const set = HashSet.make(1, 2, 3)
    * const array = [1, 2, 3]
@@ -269,7 +268,7 @@ export const isHashSet: {
  * **Example** (Adding values to a HashSet)
  *
  * ```ts
- * import * as HashSet from "effect/HashSet"
+ * import { HashSet } from "effect"
  *
  * const set = HashSet.make("a", "b")
  * const withC = HashSet.add(set, "c")
@@ -293,7 +292,7 @@ export const add: {
    * **Example** (Adding values to a HashSet)
    *
    * ```ts
-   * import * as HashSet from "effect/HashSet"
+   * import { HashSet } from "effect"
    *
    * const set = HashSet.make("a", "b")
    * const withC = HashSet.add(set, "c")
@@ -317,7 +316,7 @@ export const add: {
    * **Example** (Adding values to a HashSet)
    *
    * ```ts
-   * import * as HashSet from "effect/HashSet"
+   * import { HashSet } from "effect"
    *
    * const set = HashSet.make("a", "b")
    * const withC = HashSet.add(set, "c")
@@ -346,10 +345,9 @@ export const add: {
  * **Example** (Checking HashSet membership)
  *
  * ```ts
- * import * as HashSet from "effect/HashSet"
+ * import { Equal, Hash, HashSet } from "effect"
  *
  * // Works with any type that implements Equal
- * import { Equal, Hash } from "effect"
  *
  * const set = HashSet.make("apple", "banana", "cherry")
  *
@@ -382,10 +380,9 @@ export const has: {
    * **Example** (Checking HashSet membership)
    *
    * ```ts
-   * import * as HashSet from "effect/HashSet"
+   * import { Equal, Hash, HashSet } from "effect"
    *
    * // Works with any type that implements Equal
-   * import { Equal, Hash } from "effect"
    *
    * const set = HashSet.make("apple", "banana", "cherry")
    *
@@ -418,10 +415,9 @@ export const has: {
    * **Example** (Checking HashSet membership)
    *
    * ```ts
-   * import * as HashSet from "effect/HashSet"
+   * import { Equal, Hash, HashSet } from "effect"
    *
    * // Works with any type that implements Equal
-   * import { Equal, Hash } from "effect"
    *
    * const set = HashSet.make("apple", "banana", "cherry")
    *
@@ -459,7 +455,7 @@ export const has: {
  * **Example** (Removing values from a HashSet)
  *
  * ```ts
- * import * as HashSet from "effect/HashSet"
+ * import { HashSet } from "effect"
  *
  * const set = HashSet.make("a", "b", "c")
  * const withoutB = HashSet.remove(set, "b")
@@ -483,7 +479,7 @@ export const remove: {
    * **Example** (Removing values from a HashSet)
    *
    * ```ts
-   * import * as HashSet from "effect/HashSet"
+   * import { HashSet } from "effect"
    *
    * const set = HashSet.make("a", "b", "c")
    * const withoutB = HashSet.remove(set, "b")
@@ -507,7 +503,7 @@ export const remove: {
    * **Example** (Removing values from a HashSet)
    *
    * ```ts
-   * import * as HashSet from "effect/HashSet"
+   * import { HashSet } from "effect"
    *
    * const set = HashSet.make("a", "b", "c")
    * const withoutB = HashSet.remove(set, "b")
@@ -536,7 +532,7 @@ export const remove: {
  * **Example** (Getting the HashSet size)
  *
  * ```ts
- * import * as HashSet from "effect/HashSet"
+ * import { HashSet } from "effect"
  *
  * const empty = HashSet.empty<string>()
  * console.log(HashSet.size(empty)) // 0
@@ -559,7 +555,7 @@ export const size: <V>(self: HashSet<V>) => number = internal.size
  * **Example** (Checking whether a HashSet is empty)
  *
  * ```ts
- * import * as HashSet from "effect/HashSet"
+ * import { HashSet } from "effect"
  *
  * const empty = HashSet.empty<string>()
  * console.log(HashSet.isEmpty(empty)) // true
@@ -569,7 +565,7 @@ export const size: <V>(self: HashSet<V>) => number = internal.size
  * ```
  *
  * @category getters
- * @since 2.0.0
+ * @since 4.0.0
  */
 export const isEmpty: <V>(self: HashSet<V>) => boolean = internal.isEmpty
 
@@ -579,7 +575,7 @@ export const isEmpty: <V>(self: HashSet<V>) => boolean = internal.isEmpty
  * **Example** (Combining HashSets)
  *
  * ```ts
- * import * as HashSet from "effect/HashSet"
+ * import { HashSet } from "effect"
  *
  * const set1 = HashSet.make("a", "b")
  * const set2 = HashSet.make("b", "c")
@@ -599,7 +595,7 @@ export const union: {
    * **Example** (Combining HashSets)
    *
    * ```ts
-   * import * as HashSet from "effect/HashSet"
+   * import { HashSet } from "effect"
    *
    * const set1 = HashSet.make("a", "b")
    * const set2 = HashSet.make("b", "c")
@@ -619,7 +615,7 @@ export const union: {
    * **Example** (Combining HashSets)
    *
    * ```ts
-   * import * as HashSet from "effect/HashSet"
+   * import { HashSet } from "effect"
    *
    * const set1 = HashSet.make("a", "b")
    * const set2 = HashSet.make("b", "c")
@@ -644,7 +640,7 @@ export const union: {
  * **Example** (Finding common HashSet values)
  *
  * ```ts
- * import * as HashSet from "effect/HashSet"
+ * import { HashSet } from "effect"
  *
  * const set1 = HashSet.make("a", "b", "c")
  * const set2 = HashSet.make("b", "c", "d")
@@ -664,7 +660,7 @@ export const intersection: {
    * **Example** (Finding common HashSet values)
    *
    * ```ts
-   * import * as HashSet from "effect/HashSet"
+   * import { HashSet } from "effect"
    *
    * const set1 = HashSet.make("a", "b", "c")
    * const set2 = HashSet.make("b", "c", "d")
@@ -684,7 +680,7 @@ export const intersection: {
    * **Example** (Finding common HashSet values)
    *
    * ```ts
-   * import * as HashSet from "effect/HashSet"
+   * import { HashSet } from "effect"
    *
    * const set1 = HashSet.make("a", "b", "c")
    * const set2 = HashSet.make("b", "c", "d")
@@ -709,7 +705,7 @@ export const intersection: {
  * **Example** (Finding HashSet differences)
  *
  * ```ts
- * import * as HashSet from "effect/HashSet"
+ * import { HashSet } from "effect"
  *
  * const set1 = HashSet.make("a", "b", "c")
  * const set2 = HashSet.make("b", "d")
@@ -729,7 +725,7 @@ export const difference: {
    * **Example** (Finding HashSet differences)
    *
    * ```ts
-   * import * as HashSet from "effect/HashSet"
+   * import { HashSet } from "effect"
    *
    * const set1 = HashSet.make("a", "b", "c")
    * const set2 = HashSet.make("b", "d")
@@ -749,7 +745,7 @@ export const difference: {
    * **Example** (Finding HashSet differences)
    *
    * ```ts
-   * import * as HashSet from "effect/HashSet"
+   * import { HashSet } from "effect"
    *
    * const set1 = HashSet.make("a", "b", "c")
    * const set2 = HashSet.make("b", "d")
@@ -774,7 +770,7 @@ export const difference: {
  * **Example** (Checking subset relationships)
  *
  * ```ts
- * import * as HashSet from "effect/HashSet"
+ * import { HashSet } from "effect"
  *
  * const small = HashSet.make("a", "b")
  * const large = HashSet.make("a", "b", "c", "d")
@@ -796,7 +792,7 @@ export const isSubset: {
    * **Example** (Checking subset relationships)
    *
    * ```ts
-   * import * as HashSet from "effect/HashSet"
+   * import { HashSet } from "effect"
    *
    * const small = HashSet.make("a", "b")
    * const large = HashSet.make("a", "b", "c", "d")
@@ -818,7 +814,7 @@ export const isSubset: {
    * **Example** (Checking subset relationships)
    *
    * ```ts
-   * import * as HashSet from "effect/HashSet"
+   * import { HashSet } from "effect"
    *
    * const small = HashSet.make("a", "b")
    * const large = HashSet.make("a", "b", "c", "d")
@@ -845,7 +841,7 @@ export const isSubset: {
  * **Example** (Mapping HashSet values)
  *
  * ```ts
- * import * as HashSet from "effect/HashSet"
+ * import { HashSet } from "effect"
  *
  * const numbers = HashSet.make(1, 2, 3)
  * const doubled = HashSet.map(numbers, (n) => n * 2)
@@ -869,7 +865,7 @@ export const map: {
    * **Example** (Mapping HashSet values)
    *
    * ```ts
-   * import * as HashSet from "effect/HashSet"
+   * import { HashSet } from "effect"
    *
    * const numbers = HashSet.make(1, 2, 3)
    * const doubled = HashSet.map(numbers, (n) => n * 2)
@@ -893,7 +889,7 @@ export const map: {
    * **Example** (Mapping HashSet values)
    *
    * ```ts
-   * import * as HashSet from "effect/HashSet"
+   * import { HashSet } from "effect"
    *
    * const numbers = HashSet.make(1, 2, 3)
    * const doubled = HashSet.map(numbers, (n) => n * 2)
@@ -922,7 +918,7 @@ export const map: {
  * **Example** (Filtering HashSet values)
  *
  * ```ts
- * import * as HashSet from "effect/HashSet"
+ * import { HashSet } from "effect"
  *
  * const numbers = HashSet.make(1, 2, 3, 4, 5, 6)
  * const evens = HashSet.filter(numbers, (n) => n % 2 === 0)
@@ -941,7 +937,7 @@ export const filter: {
    * **Example** (Filtering HashSet values)
    *
    * ```ts
-   * import * as HashSet from "effect/HashSet"
+   * import { HashSet } from "effect"
    *
    * const numbers = HashSet.make(1, 2, 3, 4, 5, 6)
    * const evens = HashSet.filter(numbers, (n) => n % 2 === 0)
@@ -960,7 +956,7 @@ export const filter: {
    * **Example** (Filtering HashSet values)
    *
    * ```ts
-   * import * as HashSet from "effect/HashSet"
+   * import { HashSet } from "effect"
    *
    * const numbers = HashSet.make(1, 2, 3, 4, 5, 6)
    * const evens = HashSet.filter(numbers, (n) => n % 2 === 0)
@@ -979,7 +975,7 @@ export const filter: {
    * **Example** (Filtering HashSet values)
    *
    * ```ts
-   * import * as HashSet from "effect/HashSet"
+   * import { HashSet } from "effect"
    *
    * const numbers = HashSet.make(1, 2, 3, 4, 5, 6)
    * const evens = HashSet.filter(numbers, (n) => n % 2 === 0)
@@ -998,7 +994,7 @@ export const filter: {
    * **Example** (Filtering HashSet values)
    *
    * ```ts
-   * import * as HashSet from "effect/HashSet"
+   * import { HashSet } from "effect"
    *
    * const numbers = HashSet.make(1, 2, 3, 4, 5, 6)
    * const evens = HashSet.filter(numbers, (n) => n % 2 === 0)
@@ -1028,7 +1024,7 @@ export const filter: {
  * **Example** (Testing whether some values match)
  *
  * ```ts
- * import * as HashSet from "effect/HashSet"
+ * import { HashSet } from "effect"
  *
  * const numbers = HashSet.make(1, 2, 3, 4, 5)
  *
@@ -1049,7 +1045,7 @@ export const some: {
    * **Example** (Testing whether some values match)
    *
    * ```ts
-   * import * as HashSet from "effect/HashSet"
+   * import { HashSet } from "effect"
    *
    * const numbers = HashSet.make(1, 2, 3, 4, 5)
    *
@@ -1070,7 +1066,7 @@ export const some: {
    * **Example** (Testing whether some values match)
    *
    * ```ts
-   * import * as HashSet from "effect/HashSet"
+   * import { HashSet } from "effect"
    *
    * const numbers = HashSet.make(1, 2, 3, 4, 5)
    *
@@ -1096,7 +1092,7 @@ export const some: {
  * **Example** (Testing whether every value matches)
  *
  * ```ts
- * import * as HashSet from "effect/HashSet"
+ * import { HashSet } from "effect"
  *
  * const numbers = HashSet.make(2, 4, 6, 8)
  *
@@ -1117,7 +1113,7 @@ export const every: {
    * **Example** (Testing whether every value matches)
    *
    * ```ts
-   * import * as HashSet from "effect/HashSet"
+   * import { HashSet } from "effect"
    *
    * const numbers = HashSet.make(2, 4, 6, 8)
    *
@@ -1138,7 +1134,7 @@ export const every: {
    * **Example** (Testing whether every value matches)
    *
    * ```ts
-   * import * as HashSet from "effect/HashSet"
+   * import { HashSet } from "effect"
    *
    * const numbers = HashSet.make(2, 4, 6, 8)
    *
@@ -1164,7 +1160,7 @@ export const every: {
  * **Example** (Reducing HashSet values)
  *
  * ```ts
- * import * as HashSet from "effect/HashSet"
+ * import { HashSet } from "effect"
  *
  * const numbers = HashSet.make(1, 2, 3, 4, 5)
  * const sum = HashSet.reduce(numbers, 0, (acc, n) => acc + n)
@@ -1186,7 +1182,7 @@ export const reduce: {
    * **Example** (Reducing HashSet values)
    *
    * ```ts
-   * import * as HashSet from "effect/HashSet"
+   * import { HashSet } from "effect"
    *
    * const numbers = HashSet.make(1, 2, 3, 4, 5)
    * const sum = HashSet.reduce(numbers, 0, (acc, n) => acc + n)
@@ -1208,7 +1204,7 @@ export const reduce: {
    * **Example** (Reducing HashSet values)
    *
    * ```ts
-   * import * as HashSet from "effect/HashSet"
+   * import { HashSet } from "effect"
    *
    * const numbers = HashSet.make(1, 2, 3, 4, 5)
    * const sum = HashSet.reduce(numbers, 0, (acc, n) => acc + n)