effect 4.0.0 → 4.0.2

package/src/MutableHashMap.ts

@@ -7,6 +7,7 @@
  * Effect `Equal` and `Hash`, so callers can mix reference-based and structural
  * lookup in the same collection.
  *
+ * @stability stable
  * @since 2.0.0
  */
 import type { NonEmptyArray } from "./Array.ts"
@@ -57,6 +58,7 @@ const TypeId = "~effect/MutableHashMap"
  * @see {@link get} for reading values by key
  * @see {@link set} for mutating entries by key
  *
+ * @stability stable
  * @category models
  * @since 2.0.0
  */
@@ -83,6 +85,7 @@ export interface MutableHashMap<out K, out V> extends Iterable<[K, V]>, Pipeable
  *
  * @see {@link MutableHashMap} for the mutable hash map interface
  *
+ * @stability stable
  * @category guards
  * @since 4.0.0
  */
@@ -138,6 +141,7 @@ const MutableHashMapProto: Omit<MutableHashMap<unknown, unknown>, "backing" | "b
  * @see {@link make} for creating a map from explicit entries
  * @see {@link fromIterable} for creating a map from an iterable of entries
  *
+ * @stability stable
  * @category constructors
  * @since 2.0.0
  */
@@ -173,6 +177,7 @@ export const empty = <K, V>(): MutableHashMap<K, V> => {
  * @see {@link empty} for creating an empty map
  * @see {@link fromIterable} for creating a map from an iterable of entries
  *
+ * @stability stable
  * @category constructors
  * @since 2.0.0
  */
@@ -214,6 +219,7 @@ export const make: <Entries extends Array<readonly [any, any]>>(
  * @see {@link make} for creating a map from explicit entries
  * @see {@link empty} for creating an empty map
  *
+ * @stability stable
  * @category constructors
  * @since 2.0.0
  */
@@ -254,6 +260,7 @@ export const fromIterable = <K, V>(entries: Iterable<readonly [K, V]>): MutableH
  * @see {@link has} for checking only whether a key is present
  * @see {@link set} for inserting or replacing a value by key
  *
+ * @stability stable
  * @category getters
  * @since 2.0.0
  */
@@ -287,6 +294,7 @@ export const get: {
    * @see {@link has} for checking only whether a key is present
    * @see {@link set} for inserting or replacing a value by key
    *
+   * @stability stable
    * @category getters
    * @since 2.0.0
    */
@@ -320,6 +328,7 @@ export const get: {
    * @see {@link has} for checking only whether a key is present
    * @see {@link set} for inserting or replacing a value by key
    *
+   * @stability stable
    * @category getters
    * @since 2.0.0
    */
@@ -354,6 +363,7 @@ export const get: {
    * @see {@link has} for checking only whether a key is present
    * @see {@link set} for inserting or replacing a value by key
    *
+   * @stability stable
    * @category getters
    * @since 2.0.0
    */
@@ -387,6 +397,7 @@ export const get: {
    * @see {@link has} for checking only whether a key is present
    * @see {@link set} for inserting or replacing a value by key
    *
+   * @stability stable
    * @category getters
    * @since 2.0.0
    */
@@ -431,6 +442,7 @@ const isSimpleKey = (u: unknown): boolean => typeof u !== "object" && typeof u !
  * @see {@link values} for iterating over stored values
  * @see {@link has} for checking one key without iterating
  *
+ * @stability stable
  * @category getters
  * @since 3.8.0
  */
@@ -465,6 +477,7 @@ export const keys = <K, V>(self: MutableHashMap<K, V>): Iterable<K> => self.back
  *
  * @see {@link keys} for iterating over stored keys
  *
+ * @stability stable
  * @category getters
  * @since 3.8.0
  */
@@ -508,6 +521,7 @@ const getFromBucket = <K, V>(
  *
  * @see {@link get} for reading the value as an `Option`
  *
+ * @stability stable
  * @category predicates
  * @since 2.0.0
  */
@@ -536,6 +550,7 @@ export const has: {
    *
    * @see {@link get} for reading the value as an `Option`
    *
+   * @stability stable
    * @category predicates
    * @since 2.0.0
    */
@@ -564,6 +579,7 @@ export const has: {
    *
    * @see {@link get} for reading the value as an `Option`
    *
+   * @stability stable
    * @category predicates
    * @since 2.0.0
    */
@@ -593,6 +609,7 @@ export const has: {
    *
    * @see {@link get} for reading the value as an `Option`
    *
+   * @stability stable
    * @category predicates
    * @since 2.0.0
    */
@@ -621,6 +638,7 @@ export const has: {
    *
    * @see {@link get} for reading the value as an `Option`
    *
+   * @stability stable
    * @category predicates
    * @since 2.0.0
    */
@@ -663,6 +681,7 @@ export const has: {
  * @see {@link modifyAt} for setting or removing based on the current optional value
  * @see {@link remove} for deleting an entry by key
  *
+ * @stability stable
  * @category mutations
  * @since 2.0.0
  */
@@ -703,6 +722,7 @@ export const set: {
    * @see {@link modifyAt} for setting or removing based on the current optional value
    * @see {@link remove} for deleting an entry by key
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -743,6 +763,7 @@ export const set: {
    * @see {@link modifyAt} for setting or removing based on the current optional value
    * @see {@link remove} for deleting an entry by key
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -784,6 +805,7 @@ export const set: {
    * @see {@link modifyAt} for setting or removing based on the current optional value
    * @see {@link remove} for deleting an entry by key
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -824,6 +846,7 @@ export const set: {
    * @see {@link modifyAt} for setting or removing based on the current optional value
    * @see {@link remove} for deleting an entry by key
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -897,6 +920,7 @@ const getRefKey = <K>(
  * @see {@link set} for inserting or replacing a value directly
  * @see {@link modifyAt} for handling both missing and existing keys
  *
+ * @stability stable
  * @category mutations
  * @since 2.0.0
  */
@@ -937,6 +961,7 @@ export const modify: {
    * @see {@link set} for inserting or replacing a value directly
    * @see {@link modifyAt} for handling both missing and existing keys
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -977,6 +1002,7 @@ export const modify: {
    * @see {@link set} for inserting or replacing a value directly
    * @see {@link modifyAt} for handling both missing and existing keys
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -1018,6 +1044,7 @@ export const modify: {
    * @see {@link set} for inserting or replacing a value directly
    * @see {@link modifyAt} for handling both missing and existing keys
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -1058,6 +1085,7 @@ export const modify: {
    * @see {@link set} for inserting or replacing a value directly
    * @see {@link modifyAt} for handling both missing and existing keys
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -1133,6 +1161,7 @@ export const modify: {
  * @see {@link set} for inserting or replacing directly
  * @see {@link remove} for deleting directly
  *
+ * @stability stable
  * @category mutations
  * @since 2.0.0
  */
@@ -1186,6 +1215,7 @@ export const modifyAt: {
    * @see {@link set} for inserting or replacing directly
    * @see {@link remove} for deleting directly
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -1239,6 +1269,7 @@ export const modifyAt: {
    * @see {@link set} for inserting or replacing directly
    * @see {@link remove} for deleting directly
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -1297,6 +1328,7 @@ export const modifyAt: {
    * @see {@link set} for inserting or replacing directly
    * @see {@link remove} for deleting directly
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -1350,6 +1382,7 @@ export const modifyAt: {
    * @see {@link set} for inserting or replacing directly
    * @see {@link remove} for deleting directly
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -1409,6 +1442,7 @@ export const modifyAt: {
  * @see {@link clear} for removing all entries
  * @see {@link modifyAt} for conditionally removing based on the current value
  *
+ * @stability stable
  * @category mutations
  * @since 2.0.0
  */
@@ -1451,6 +1485,7 @@ export const remove: {
    * @see {@link clear} for removing all entries
    * @see {@link modifyAt} for conditionally removing based on the current value
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -1493,6 +1528,7 @@ export const remove: {
    * @see {@link clear} for removing all entries
    * @see {@link modifyAt} for conditionally removing based on the current value
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -1536,6 +1572,7 @@ export const remove: {
    * @see {@link clear} for removing all entries
    * @see {@link modifyAt} for conditionally removing based on the current value
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -1578,6 +1615,7 @@ export const remove: {
    * @see {@link clear} for removing all entries
    * @see {@link modifyAt} for conditionally removing based on the current value
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -1642,6 +1680,7 @@ export const remove: {
  * @see {@link remove} for deleting one key
  * @see {@link empty} for creating a fresh empty map
  *
+ * @stability stable
  * @category mutations
  * @since 2.0.0
  */
@@ -1679,6 +1718,7 @@ export const clear = <K, V>(self: MutableHashMap<K, V>) => {
  *
  * @see {@link isEmpty} for checking whether the map has no entries
  *
+ * @stability stable
  * @category getters
  * @since 2.0.0
  */
@@ -1693,6 +1733,7 @@ export const size = <K, V>(self: MutableHashMap<K, V>): number => self.backing.s
  *
  * @see {@link size} for reading the exact number of entries
  *
+ * @stability stable
  * @category predicates
  * @since 2.0.0
  */
@@ -1714,6 +1755,7 @@ export const isEmpty = <K, V>(self: MutableHashMap<K, V>): boolean => self.backi
  * @see {@link keys} for iterating only keys
  * @see {@link values} for iterating only values
  *
+ * @stability stable
  * @category traversing
  * @since 2.0.0
  */
@@ -1734,6 +1776,7 @@ export const forEach: {
    * @see {@link keys} for iterating only keys
    * @see {@link values} for iterating only values
    *
+   * @stability stable
    * @category traversing
    * @since 2.0.0
    */
@@ -1754,6 +1797,7 @@ export const forEach: {
    * @see {@link keys} for iterating only keys
    * @see {@link values} for iterating only values
    *
+   * @stability stable
    * @category traversing
    * @since 2.0.0
    */

package/src/MutableHashSet.ts

@@ -7,6 +7,7 @@
  * follows the same hashing and equality rules as the underlying mutable hash
  * map.
  *
+ * @stability stable
  * @since 2.0.0
  */
 import { format } from "./Formatter.ts"
@@ -59,6 +60,7 @@ const TypeId = "~effect/MutableHashSet"
  * MutableHashSet.size(set) // => 3
  * ```
  *
+ * @stability stable
  * @category models
  * @since 2.0.0
  */
@@ -84,6 +86,7 @@ export interface MutableHashSet<out V> extends Iterable<V>, Pipeable, Inspectabl
  *
  * @see {@link MutableHashSet} for the mutable hash set interface
  *
+ * @stability stable
  * @category guards
  * @since 4.0.0
  */
@@ -148,6 +151,7 @@ const fromHashMap = <V>(keyMap: MutableHashMap.MutableHashMap<V, boolean>): Muta
  * @see {@link fromIterable} for creating a set from an iterable of values
  * @see {@link clear} for emptying an existing mutable set
  *
+ * @stability stable
  * @category constructors
  * @since 2.0.0
  */
@@ -179,6 +183,7 @@ export const empty = <K = never>(): MutableHashSet<K> => fromHashMap(MutableHash
  * Array.from(MutableHashSet.fromIterable("hello")) // => ["h", "e", "l", "o"]
  * ```
  *
+ * @stability stable
  * @category constructors
  * @since 2.0.0
  */
@@ -212,6 +217,7 @@ export const fromIterable = <K = never>(keys: Iterable<K>): MutableHashSet<K> =>
  * MutableHashSet.size(MutableHashSet.make("hello", 42, true, "hello")) // => 3
  * ```
  *
+ * @stability stable
  * @category constructors
  * @since 2.0.0
  */
@@ -251,6 +257,7 @@ export const make = <Keys extends ReadonlyArray<unknown>>(
  * MutableHashSet.size(set) // => 3
  * ```
  *
+ * @stability stable
  * @category mutations
  * @since 2.0.0
  */
@@ -287,6 +294,7 @@ export const add: {
    * MutableHashSet.size(set) // => 3
    * ```
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -323,6 +331,7 @@ export const add: {
    * MutableHashSet.size(set) // => 3
    * ```
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -366,6 +375,7 @@ export const add: {
  * @see {@link add} for adding a value to the set
  * @see {@link remove} for removing a value from the set
  *
+ * @stability stable
  * @category predicates
  * @since 2.0.0
  */
@@ -404,6 +414,7 @@ export const has: {
    * @see {@link add} for adding a value to the set
    * @see {@link remove} for removing a value from the set
    *
+   * @stability stable
    * @category predicates
    * @since 2.0.0
    */
@@ -442,6 +453,7 @@ export const has: {
    * @see {@link add} for adding a value to the set
    * @see {@link remove} for removing a value from the set
    *
+   * @stability stable
    * @category predicates
    * @since 2.0.0
    */
@@ -483,6 +495,7 @@ export const has: {
  * MutableHashSet.size(set) // => 1
  * ```
  *
+ * @stability stable
  * @category mutations
  * @since 2.0.0
  */
@@ -519,6 +532,7 @@ export const remove: {
    * MutableHashSet.size(set) // => 1
    * ```
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -555,6 +569,7 @@ export const remove: {
    * MutableHashSet.size(set) // => 1
    * ```
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -591,6 +606,7 @@ export const remove: {
  * MutableHashSet.size(set) // => 0
  * ```
  *
+ * @stability stable
  * @category getters
  * @since 2.0.0
  */
@@ -625,6 +641,7 @@ export const size = <V>(self: MutableHashSet<V>): number => MutableHashMap.size(
  * MutableHashSet.size(set) // => 1
  * ```
  *
+ * @stability stable
  * @category mutations
  * @since 2.0.0
  */

package/src/MutableList.ts

@@ -6,6 +6,7 @@
  * the same list object in place and keep its `length` field current. Taking
  * from an empty list returns the `Empty` symbol.
  *
+ * @stability stable
  * @since 4.0.0
  */
 import * as Arr from "./Array.ts"
@@ -30,6 +31,7 @@ import * as Count from "./internal/count.ts"
  * list.length // => 0
  * ```
  *
+ * @stability stable
  * @category models
  * @since 2.0.0
  */
@@ -43,6 +45,7 @@ export interface MutableList<in out A> {
  * The MutableList namespace contains type definitions and utilities for working
  * with mutable linked lists.
  *
+ * @stability stable
  * @since 2.0.0
  */
 export declare namespace MutableList {
@@ -103,6 +106,7 @@ export declare namespace MutableList {
  * MutableList.take(list) === MutableList.Empty // => true
  * ```
  *
+ * @stability stable
  * @category symbols
  * @since 4.0.0
  */
@@ -129,6 +133,7 @@ export const Empty: unique symbol = Symbol.for("effect/MutableList/Empty")
  * takeAndDouble(list) // => 10
  * ```
  *
+ * @stability stable
  * @category symbols
  * @since 4.0.0
  */
@@ -150,6 +155,7 @@ export type Empty = typeof Empty
  * list.length // => 0
  * ```
  *
+ * @stability stable
  * @category constructors
  * @since 2.0.0
  */
@@ -202,6 +208,7 @@ const emptyBucket = <A = never>(): MutableList.Bucket<A> => ({
  * list.length // => 3
  * ```
  *
+ * @stability stable
  * @category mutations
  * @since 2.0.0
  */
@@ -234,6 +241,7 @@ export const append = <A>(self: MutableList<A>, message: A): void => {
  * MutableList.toArray(list) // => ["first", "second", "third", "last"]
  * ```
  *
+ * @stability stable
  * @category mutations
  * @since 2.0.0
  */
@@ -266,6 +274,7 @@ export const prepend = <A>(self: MutableList<A>, message: A): void => {
  * MutableList.toArray(list) // => [1, 2, 3, 4, 5]
  * ```
  *
+ * @stability stable
  * @category mutations
  * @since 4.0.0
  */
@@ -299,6 +308,7 @@ export const prependAll = <A>(self: MutableList<A>, messages: Iterable<A>): void
  * MutableList.toArray(list) // => [1, 2, 3, 4]
  * ```
  *
+ * @stability stable
  * @category mutations
  * @since 4.0.0
  */
@@ -334,6 +344,7 @@ export const prependAllUnsafe = <A>(self: MutableList<A>, messages: ReadonlyArra
  * list.length // => 5
  * ```
  *
+ * @stability stable
  * @category mutations
  * @since 4.0.0
  */
@@ -368,6 +379,7 @@ export const appendAll = <A>(self: MutableList<A>, messages: Iterable<A>): numbe
  * MutableList.toArray(list) // => [1, 2, 3, 4]
  * ```
  *
+ * @stability stable
  * @category mutations
  * @since 4.0.0
  */
@@ -409,6 +421,7 @@ export const appendAllUnsafe = <A>(self: MutableList<A>, messages: ReadonlyArray
  * MutableList.take(list) === MutableList.Empty // => true
  * ```
  *
+ * @stability stable
  * @category mutations
  * @since 4.0.0
  */
@@ -440,6 +453,7 @@ export const clear = <A>(self: MutableList<A>): void => {
  * list.length // => 7
  * ```
  *
+ * @stability stable
  * @category mutations
  * @since 4.0.0
  */
@@ -493,6 +507,7 @@ export const takeN = <A>(self: MutableList<A>, n: number): Array<A> => {
  * @see {@link takeN} for removing up to `n` values and returning them as an array
  * @see {@link clear} for removing every value from the list
  *
+ * @stability stable
  * @category mutations
  * @since 4.0.0
  */
@@ -538,6 +553,7 @@ export const takeNVoid = <A>(self: MutableList<A>, n: number): void => {
  * list.length // => 0
  * ```
  *
+ * @stability stable
  * @category mutations
  * @since 4.0.0
  */
@@ -561,6 +577,7 @@ export const takeAll = <A>(self: MutableList<A>): Array<A> => takeN(self, self.l
  * list.length // => 2
  * ```
  *
+ * @stability stable
  * @category mutations
  * @since 4.0.0
  */
@@ -598,6 +615,7 @@ export const take = <A>(self: MutableList<A>): Empty | A => {
  *
  * @see {@link takeN} for removing up to `n` values and returning them as an array
  *
+ * @stability stable
  * @category converting
  * @since 4.0.0
  */
@@ -629,6 +647,7 @@ export const toArrayN = <A>(self: MutableList<A>, n: number): Array<A> => {
  *
  * @see {@link takeAll} for converting all elements to an array and clearing the list
  *
+ * @stability stable
  * @category converting
  * @since 4.0.0
  */
@@ -652,6 +671,7 @@ export const toArray = <A>(self: MutableList<A>): Array<A> => toArrayN(self, sel
  * MutableList.toArray(list) // => [2, 4, 6, 8, 10]
  * ```
  *
+ * @stability stable
  * @category mutations
  * @since 4.0.0
  */
@@ -711,6 +731,7 @@ export const filter = <A>(self: MutableList<A>, f: (value: A, i: number) => bool
  * MutableList.toArray(list) // => ["banana", "cherry"]
  * ```
  *
+ * @stability stable
  * @category mutations
  * @since 4.0.0
  */