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

package/src/MutableHashMap.ts

@@ -21,7 +21,6 @@
  * - Size: O(1)
  * - Iteration: O(n)
  *
- * @category data-structures
  * @since 2.0.0
  */
 import type { NonEmptyArray } from "./Array.ts"
@@ -48,7 +47,7 @@ const TypeId = "~effect/collections/MutableHashMap"
  * **Example** (Using a mutable hash map)
  *
  * ```ts
- * import * as MutableHashMap from "effect/MutableHashMap"
+ * import { MutableHashMap } from "effect"
  *
  * // Create a mutable hash map with string keys and number values
  * const map: MutableHashMap.MutableHashMap<string, number> = MutableHashMap
@@ -116,7 +115,7 @@ const MutableHashMapProto: Omit<MutableHashMap<unknown, unknown>, "backing" | "b
  * **Example** (Creating an empty map)
  *
  * ```ts
- * import * as MutableHashMap from "effect/MutableHashMap"
+ * import { MutableHashMap } from "effect"
  *
  * const map = MutableHashMap.empty<string, number>()
  *
@@ -143,7 +142,7 @@ export const empty = <K, V>(): MutableHashMap<K, V> => {
  * **Example** (Creating a map from entries)
  *
  * ```ts
- * import * as MutableHashMap from "effect/MutableHashMap"
+ * import { MutableHashMap } from "effect"
  *
  * const map = MutableHashMap.make(
  *   ["key1", 42],
@@ -171,7 +170,7 @@ export const make: <Entries extends Array<readonly [any, any]>>(
  * **Example** (Creating a map from an iterable)
  *
  * ```ts
- * import * as MutableHashMap from "effect/MutableHashMap"
+ * import { MutableHashMap } from "effect"
  *
  * const entries = [
  *   ["apple", 1],
@@ -209,7 +208,7 @@ export const fromIterable = <K, V>(entries: Iterable<readonly [K, V]>): MutableH
  * **Example** (Getting a value)
  *
  * ```ts
- * import * as MutableHashMap from "effect/MutableHashMap"
+ * import { MutableHashMap } from "effect"
  *
  * const map = MutableHashMap.make(["key1", 42], ["key2", 100])
  *
@@ -234,7 +233,7 @@ export const get: {
    * **Example** (Getting a value)
    *
    * ```ts
-   * import * as MutableHashMap from "effect/MutableHashMap"
+   * import { MutableHashMap } from "effect"
    *
    * const map = MutableHashMap.make(["key1", 42], ["key2", 100])
    *
@@ -259,7 +258,7 @@ export const get: {
    * **Example** (Getting a value)
    *
    * ```ts
-   * import * as MutableHashMap from "effect/MutableHashMap"
+   * import { MutableHashMap } from "effect"
    *
    * const map = MutableHashMap.make(["key1", 42], ["key2", 100])
    *
@@ -285,7 +284,7 @@ export const get: {
    * **Example** (Getting a value)
    *
    * ```ts
-   * import * as MutableHashMap from "effect/MutableHashMap"
+   * import { MutableHashMap } from "effect"
    *
    * const map = MutableHashMap.make(["key1", 42], ["key2", 100])
    *
@@ -310,7 +309,7 @@ export const get: {
    * **Example** (Getting a value)
    *
    * ```ts
-   * import * as MutableHashMap from "effect/MutableHashMap"
+   * import { MutableHashMap } from "effect"
    *
    * const map = MutableHashMap.make(["key1", 42], ["key2", 100])
    *
@@ -353,7 +352,7 @@ const isSimpleKey = (u: unknown): boolean => typeof u !== "object" && typeof u !
  * **Example** (Reading keys)
  *
  * ```ts
- * import * as MutableHashMap from "effect/MutableHashMap"
+ * import { MutableHashMap } from "effect"
  *
  * const map = MutableHashMap.make(
  *   ["apple", 1],
@@ -379,7 +378,7 @@ export const keys = <K, V>(self: MutableHashMap<K, V>): Iterable<K> => self.back
  * **Example** (Reading values)
  *
  * ```ts
- * import * as MutableHashMap from "effect/MutableHashMap"
+ * import { MutableHashMap } from "effect"
  *
  * const map = MutableHashMap.make(
  *   ["apple", 1],
@@ -425,7 +424,7 @@ const getFromBucket = <K, V>(
  * **Example** (Checking for a key)
  *
  * ```ts
- * import * as MutableHashMap from "effect/MutableHashMap"
+ * import { MutableHashMap } from "effect"
  *
  * const map = MutableHashMap.make(["key1", 42], ["key2", 100])
  *
@@ -447,7 +446,7 @@ export const has: {
    * **Example** (Checking for a key)
    *
    * ```ts
-   * import * as MutableHashMap from "effect/MutableHashMap"
+   * import { MutableHashMap } from "effect"
    *
    * const map = MutableHashMap.make(["key1", 42], ["key2", 100])
    *
@@ -469,7 +468,7 @@ export const has: {
    * **Example** (Checking for a key)
    *
    * ```ts
-   * import * as MutableHashMap from "effect/MutableHashMap"
+   * import { MutableHashMap } from "effect"
    *
    * const map = MutableHashMap.make(["key1", 42], ["key2", 100])
    *
@@ -492,7 +491,7 @@ export const has: {
    * **Example** (Checking for a key)
    *
    * ```ts
-   * import * as MutableHashMap from "effect/MutableHashMap"
+   * import { MutableHashMap } from "effect"
    *
    * const map = MutableHashMap.make(["key1", 42], ["key2", 100])
    *
@@ -514,7 +513,7 @@ export const has: {
    * **Example** (Checking for a key)
    *
    * ```ts
-   * import * as MutableHashMap from "effect/MutableHashMap"
+   * import { MutableHashMap } from "effect"
    *
    * const map = MutableHashMap.make(["key1", 42], ["key2", 100])
    *
@@ -539,7 +538,7 @@ export const has: {
  * **Example** (Setting key-value pairs)
  *
  * ```ts
- * import * as MutableHashMap from "effect/MutableHashMap"
+ * import { MutableHashMap } from "effect"
  *
  * const map = MutableHashMap.empty<string, number>()
  *
@@ -571,7 +570,7 @@ export const set: {
    * **Example** (Setting key-value pairs)
    *
    * ```ts
-   * import * as MutableHashMap from "effect/MutableHashMap"
+   * import { MutableHashMap } from "effect"
    *
    * const map = MutableHashMap.empty<string, number>()
    *
@@ -603,7 +602,7 @@ export const set: {
    * **Example** (Setting key-value pairs)
    *
    * ```ts
-   * import * as MutableHashMap from "effect/MutableHashMap"
+   * import { MutableHashMap } from "effect"
    *
    * const map = MutableHashMap.empty<string, number>()
    *
@@ -636,7 +635,7 @@ export const set: {
    * **Example** (Setting key-value pairs)
    *
    * ```ts
-   * import * as MutableHashMap from "effect/MutableHashMap"
+   * import { MutableHashMap } from "effect"
    *
    * const map = MutableHashMap.empty<string, number>()
    *
@@ -668,7 +667,7 @@ export const set: {
    * **Example** (Setting key-value pairs)
    *
    * ```ts
-   * import * as MutableHashMap from "effect/MutableHashMap"
+   * import { MutableHashMap } from "effect"
    *
    * const map = MutableHashMap.empty<string, number>()
    *
@@ -740,7 +739,7 @@ const getRefKey = <K>(
  * **Example** (Modifying existing values)
  *
  * ```ts
- * import * as MutableHashMap from "effect/MutableHashMap"
+ * import { MutableHashMap } from "effect"
  *
  * const map = MutableHashMap.make(["count", 5], ["total", 100])
  *
@@ -772,7 +771,7 @@ export const modify: {
    * **Example** (Modifying existing values)
    *
    * ```ts
-   * import * as MutableHashMap from "effect/MutableHashMap"
+   * import { MutableHashMap } from "effect"
    *
    * const map = MutableHashMap.make(["count", 5], ["total", 100])
    *
@@ -804,7 +803,7 @@ export const modify: {
    * **Example** (Modifying existing values)
    *
    * ```ts
-   * import * as MutableHashMap from "effect/MutableHashMap"
+   * import { MutableHashMap } from "effect"
    *
    * const map = MutableHashMap.make(["count", 5], ["total", 100])
    *
@@ -837,7 +836,7 @@ export const modify: {
    * **Example** (Modifying existing values)
    *
    * ```ts
-   * import * as MutableHashMap from "effect/MutableHashMap"
+   * import { MutableHashMap } from "effect"
    *
    * const map = MutableHashMap.make(["count", 5], ["total", 100])
    *
@@ -869,7 +868,7 @@ export const modify: {
    * **Example** (Modifying existing values)
    *
    * ```ts
-   * import * as MutableHashMap from "effect/MutableHashMap"
+   * import { MutableHashMap } from "effect"
    *
    * const map = MutableHashMap.make(["count", 5], ["total", 100])
    *
@@ -931,8 +930,7 @@ export const modify: {
  * **Example** (Updating or removing a key)
  *
  * ```ts
- * import * as MutableHashMap from "effect/MutableHashMap"
- * import * as Option from "effect/Option"
+ * import { MutableHashMap, Option } from "effect"
  *
  * const map = MutableHashMap.make(["count", 5])
  *
@@ -978,8 +976,7 @@ export const modifyAt: {
    * **Example** (Updating or removing a key)
    *
    * ```ts
-   * import * as MutableHashMap from "effect/MutableHashMap"
-   * import * as Option from "effect/Option"
+   * import { MutableHashMap, Option } from "effect"
    *
    * const map = MutableHashMap.make(["count", 5])
    *
@@ -1025,8 +1022,7 @@ export const modifyAt: {
    * **Example** (Updating or removing a key)
    *
    * ```ts
-   * import * as MutableHashMap from "effect/MutableHashMap"
-   * import * as Option from "effect/Option"
+   * import { MutableHashMap, Option } from "effect"
    *
    * const map = MutableHashMap.make(["count", 5])
    *
@@ -1077,8 +1073,7 @@ export const modifyAt: {
    * **Example** (Updating or removing a key)
    *
    * ```ts
-   * import * as MutableHashMap from "effect/MutableHashMap"
-   * import * as Option from "effect/Option"
+   * import { MutableHashMap, Option } from "effect"
    *
    * const map = MutableHashMap.make(["count", 5])
    *
@@ -1124,8 +1119,7 @@ export const modifyAt: {
    * **Example** (Updating or removing a key)
    *
    * ```ts
-   * import * as MutableHashMap from "effect/MutableHashMap"
-   * import * as Option from "effect/Option"
+   * import { MutableHashMap, Option } from "effect"
    *
    * const map = MutableHashMap.make(["count", 5])
    *
@@ -1186,7 +1180,7 @@ export const modifyAt: {
  * **Example** (Removing a key)
  *
  * ```ts
- * import * as MutableHashMap from "effect/MutableHashMap"
+ * import { MutableHashMap } from "effect"
  *
  * const map = MutableHashMap.make(
  *   ["key1", 42],
@@ -1222,7 +1216,7 @@ export const remove: {
    * **Example** (Removing a key)
    *
    * ```ts
-   * import * as MutableHashMap from "effect/MutableHashMap"
+   * import { MutableHashMap } from "effect"
    *
    * const map = MutableHashMap.make(
    *   ["key1", 42],
@@ -1258,7 +1252,7 @@ export const remove: {
    * **Example** (Removing a key)
    *
    * ```ts
-   * import * as MutableHashMap from "effect/MutableHashMap"
+   * import { MutableHashMap } from "effect"
    *
    * const map = MutableHashMap.make(
    *   ["key1", 42],
@@ -1295,7 +1289,7 @@ export const remove: {
    * **Example** (Removing a key)
    *
    * ```ts
-   * import * as MutableHashMap from "effect/MutableHashMap"
+   * import { MutableHashMap } from "effect"
    *
    * const map = MutableHashMap.make(
    *   ["key1", 42],
@@ -1331,7 +1325,7 @@ export const remove: {
    * **Example** (Removing a key)
    *
    * ```ts
-   * import * as MutableHashMap from "effect/MutableHashMap"
+   * import { MutableHashMap } from "effect"
    *
    * const map = MutableHashMap.make(
    *   ["key1", 42],
@@ -1393,7 +1387,7 @@ export const remove: {
  * **Example** (Clearing all entries)
  *
  * ```ts
- * import * as MutableHashMap from "effect/MutableHashMap"
+ * import { MutableHashMap } from "effect"
  *
  * const map = MutableHashMap.make(
  *   ["key1", 42],
@@ -1429,7 +1423,7 @@ export const clear = <K, V>(self: MutableHashMap<K, V>) => {
  * **Example** (Checking map size)
  *
  * ```ts
- * import * as MutableHashMap from "effect/MutableHashMap"
+ * import { MutableHashMap } from "effect"
  *
  * const map = MutableHashMap.empty<string, number>()
  * console.log(MutableHashMap.size(map)) // 0
@@ -1453,6 +1447,7 @@ export const size = <K, V>(self: MutableHashMap<K, V>): number => self.backing.s
 /**
  * Returns `true` when the `MutableHashMap` contains no key-value pairs.
  *
+ * @category predicates
  * @since 2.0.0
  */
 export const isEmpty = <K, V>(self: MutableHashMap<K, V>): boolean => self.backing.size === 0
@@ -1463,6 +1458,7 @@ export const isEmpty = <K, V>(self: MutableHashMap<K, V>): boolean => self.backi
  * Iteration follows the backing map's order. The callback receives the value
  * first and the key second, matching `Map.prototype.forEach`.
  *
+ * @category traversing
  * @since 2.0.0
  */
 export const forEach: {
@@ -1472,6 +1468,7 @@ export const forEach: {
    * Iteration follows the backing map's order. The callback receives the value
    * first and the key second, matching `Map.prototype.forEach`.
    *
+   * @category traversing
    * @since 2.0.0
    */
   <K, V>(f: (value: V, key: K) => void): (self: MutableHashMap<K, V>) => void
@@ -1481,6 +1478,7 @@ export const forEach: {
    * Iteration follows the backing map's order. The callback receives the value
    * first and the key second, matching `Map.prototype.forEach`.
    *
+   * @category traversing
    * @since 2.0.0
    */
   <K, V>(self: MutableHashMap<K, V>, f: (value: V, key: K) => void): void

package/src/MutableHashSet.ts

@@ -68,8 +68,6 @@
  * // Output: ["apple", "cherry"]
  * ```
  *
- * @fileoverview
- * @category data-structures
  * @since 2.0.0
  */
 import { format } from "./Formatter.ts"

package/src/MutableList.ts

@@ -46,8 +46,6 @@
  * - {@link remove} uses JavaScript strict equality semantics, not structural
  *   equality
  *
- * @fileoverview
- * @category data-structures
  * @since 4.0.0
  */
 import * as Arr from "./Array.ts"
@@ -60,7 +58,7 @@ import * as Arr from "./Array.ts"
  * **Example** (Creating and consuming a mutable list)
  *
  * ```ts
- * import * as MutableList from "effect/MutableList"
+ * import { MutableList } from "effect"
  *
  * // Create a mutable list
  * const list: MutableList.MutableList<number> = MutableList.make()
@@ -82,7 +80,7 @@ import * as Arr from "./Array.ts"
  * ```
  *
  * @category models
- * @since 4.0.0
+ * @since 2.0.0
  */
 export interface MutableList<in out A> {
   head: MutableList.Bucket<A> | undefined
@@ -97,7 +95,7 @@ export interface MutableList<in out A> {
  * **Example** (Typing queue processors)
  *
  * ```ts
- * import * as MutableList from "effect/MutableList"
+ * import { MutableList } from "effect"
  *
  * // Type annotation using the namespace
  * const processQueue = (queue: MutableList.MutableList<string>) => {
@@ -124,8 +122,7 @@ export interface MutableList<in out A> {
  * }
  * ```
  *
- * @category models
- * @since 4.0.0
+ * @since 2.0.0
  */
 export declare namespace MutableList {
   /**
@@ -139,7 +136,7 @@ export declare namespace MutableList {
    * **Example** (Inspecting buckets)
    *
    * ```ts
-   * import * as MutableList from "effect/MutableList"
+   * import { MutableList } from "effect"
    *
    * const list = MutableList.make<number>()
    * MutableList.append(list, 1)
@@ -179,7 +176,7 @@ export declare namespace MutableList {
  * **Example** (Checking for empty results)
  *
  * ```ts
- * import * as MutableList from "effect/MutableList"
+ * import { MutableList } from "effect"
  *
  * const list = MutableList.make<string>()
  *
@@ -218,7 +215,7 @@ export const Empty: unique symbol = Symbol.for("effect/MutableList/Empty")
  * **Example** (Handling empty results type-safely)
  *
  * ```ts
- * import * as MutableList from "effect/MutableList"
+ * import { MutableList } from "effect"
  *
  * const list = MutableList.make<number>()
  *
@@ -267,7 +264,7 @@ export type Empty = typeof Empty
  * **Example** (Creating an empty mutable list)
  *
  * ```ts
- * import * as MutableList from "effect/MutableList"
+ * import { MutableList } from "effect"
  *
  * const list = MutableList.make<string>()
  *
@@ -285,7 +282,7 @@ export type Empty = typeof Empty
  * ```
  *
  * @category constructors
- * @since 4.0.0
+ * @since 2.0.0
  */
 export const make = <A>(): MutableList<A> => ({
   head: undefined,
@@ -307,7 +304,7 @@ const emptyBucket = <A = never>(): MutableList.Bucket<A> => ({
  * **Example** (Appending elements)
  *
  * ```ts
- * import * as MutableList from "effect/MutableList"
+ * import { MutableList } from "effect"
  *
  * const list = MutableList.make<number>()
  *
@@ -330,7 +327,7 @@ const emptyBucket = <A = never>(): MutableList.Bucket<A> => ({
  * ```
  *
  * @category mutations
- * @since 4.0.0
+ * @since 2.0.0
  */
 export const append = <A>(self: MutableList<A>, message: A): void => {
   if (!self.tail) {
@@ -350,7 +347,7 @@ export const append = <A>(self: MutableList<A>, message: A): void => {
  * **Example** (Prepending elements)
  *
  * ```ts
- * import * as MutableList from "effect/MutableList"
+ * import { MutableList } from "effect"
  *
  * const list = MutableList.make<string>()
  *
@@ -373,7 +370,7 @@ export const append = <A>(self: MutableList<A>, message: A): void => {
  * ```
  *
  * @category mutations
- * @since 4.0.0
+ * @since 2.0.0
  */
 export const prepend = <A>(self: MutableList<A>, message: A): void => {
   self.head = {
@@ -393,7 +390,7 @@ export const prepend = <A>(self: MutableList<A>, message: A): void => {
  * **Example** (Prepending multiple elements)
  *
  * ```ts
- * import * as MutableList from "effect/MutableList"
+ * import { MutableList } from "effect"
  *
  * const list = MutableList.make<number>()
  * MutableList.append(list, 4)
@@ -429,7 +426,7 @@ export const prependAll = <A>(self: MutableList<A>, messages: Iterable<A>): void
  * **Example** (Prepending arrays with optional mutation)
  *
  * ```ts
- * import * as MutableList from "effect/MutableList"
+ * import { MutableList } from "effect"
  *
  * const list = MutableList.make<number>()
  * MutableList.append(list, 4)
@@ -467,7 +464,7 @@ export const prependAllUnsafe = <A>(self: MutableList<A>, messages: ReadonlyArra
  * **Example** (Appending multiple elements)
  *
  * ```ts
- * import * as MutableList from "effect/MutableList"
+ * import { MutableList } from "effect"
  *
  * const list = MutableList.make<number>()
  * MutableList.append(list, 1)
@@ -512,7 +509,7 @@ export const appendAll = <A>(self: MutableList<A>, messages: Iterable<A>): numbe
  * **Example** (Appending arrays with optional mutation)
  *
  * ```ts
- * import * as MutableList from "effect/MutableList"
+ * import { MutableList } from "effect"
  *
  * const list = MutableList.make<number>()
  * MutableList.append(list, 1)
@@ -564,7 +561,7 @@ export const appendAllUnsafe = <A>(self: MutableList<A>, messages: ReadonlyArray
  * **Example** (Clearing a mutable list)
  *
  * ```ts
- * import * as MutableList from "effect/MutableList"
+ * import { MutableList } from "effect"
  *
  * const list = MutableList.make<number>()
  * MutableList.appendAll(list, [1, 2, 3, 4, 5])
@@ -604,7 +601,7 @@ export const clear = <A>(self: MutableList<A>): void => {
  * **Example** (Taking batches)
  *
  * ```ts
- * import * as MutableList from "effect/MutableList"
+ * import { MutableList } from "effect"
  *
  * const list = MutableList.make<number>()
  * MutableList.appendAll(list, [1, 2, 3, 4, 5, 6, 7, 8, 9, 10])
@@ -709,7 +706,7 @@ export const takeNVoid = <A>(self: MutableList<A>, n: number): void => {
  * **Example** (Draining all elements)
  *
  * ```ts
- * import * as MutableList from "effect/MutableList"
+ * import { MutableList } from "effect"
  *
  * const list = MutableList.make<string>()
  * MutableList.appendAll(list, ["apple", "banana", "cherry"])
@@ -754,7 +751,7 @@ export const takeAll = <A>(self: MutableList<A>): Array<A> => takeN(self, self.l
  * **Example** (Taking one element)
  *
  * ```ts
- * import * as MutableList from "effect/MutableList"
+ * import { MutableList } from "effect"
  *
  * const list = MutableList.make<string>()
  * MutableList.appendAll(list, ["first", "second", "third"])
@@ -854,7 +851,7 @@ export const toArray = <A>(self: MutableList<A>): Array<A> => toArrayN(self, sel
  * **Example** (Filtering in place)
  *
  * ```ts
- * import * as MutableList from "effect/MutableList"
+ * import { MutableList } from "effect"
  *
  * const list = MutableList.make<number>()
  * MutableList.appendAll(list, [1, 2, 3, 4, 5, 6, 7, 8, 9, 10])
@@ -921,7 +918,7 @@ export const filter = <A>(self: MutableList<A>, f: (value: A, i: number) => bool
  * **Example** (Removing matching values)
  *
  * ```ts
- * import * as MutableList from "effect/MutableList"
+ * import { MutableList } from "effect"
  *
  * const list = MutableList.make<string>()
  * MutableList.appendAll(list, ["apple", "banana", "apple", "cherry", "apple"])

package/src/MutableRef.ts

@@ -30,7 +30,6 @@
  * - `compareAndSet` compares with Effect equality semantics, not only JavaScript reference equality
  * - For state that must participate in `Effect` workflows, interruption, or fiber coordination, prefer higher-level Effect data types
  *
- * @category data-structures
  * @since 2.0.0
  */
 import * as Equal from "./Equal.ts"