effect 4.0.1 → 4.0.2

package/src/HashRing.ts

@@ -7,6 +7,7 @@
  * can create rings, add or remove nodes by `PrimaryKey`, route an input string
  * to a node, and compute shard assignments.
  *
+ * @stability unstable
  * @since 4.0.0
  */
 import { dual } from "./Function.ts"
@@ -34,6 +35,7 @@ const TypeId = "~effect/HashRing" as const
  * Nodes are identified by their `PrimaryKey` value and can be iterated from the
  * ring.
  *
+ * @stability unstable
  * @category models
  * @since 3.19.0
  */
@@ -66,6 +68,7 @@ export interface HashRing<A extends PrimaryKey.PrimaryKey> extends Pipeable, Ite
  * @see {@link HashRing} for the type narrowed by this guard
  * @see {@link make} for creating an empty `HashRing`
  *
+ * @stability unstable
  * @category guards
  * @since 3.19.0
  */
@@ -87,6 +90,7 @@ export const isHashRing = (u: unknown): u is HashRing<any> => hasProperty(u, Typ
  * @see {@link add} for registering one node after creation
  * @see {@link addMany} for registering several nodes after creation
  *
+ * @stability unstable
  * @category constructors
  * @since 3.19.0
  */
@@ -124,6 +128,7 @@ const Proto = {
  *
  * Use to register or update several nodes in a `HashRing` at the same weight.
  *
+ * @stability unstable
  * @category combinators
  * @since 3.19.0
  */
@@ -136,6 +141,7 @@ export const addMany: {
    *
    * Use to register or update several nodes in a `HashRing` at the same weight.
    *
+   * @stability unstable
    * @category combinators
    * @since 3.19.0
    */
@@ -153,6 +159,7 @@ export const addMany: {
    *
    * Use to register or update several nodes in a `HashRing` at the same weight.
    *
+   * @stability unstable
    * @category combinators
    * @since 3.19.0
    */
@@ -240,6 +247,7 @@ function updateTotalWeight<A extends PrimaryKey.PrimaryKey>(self: HashRing<A>) {
  * @see {@link remove} for unregistering a node
  * @see {@link has} for checking primary-key membership
  *
+ * @stability unstable
  * @category combinators
  * @since 3.19.0
  */
@@ -266,6 +274,7 @@ export const add: {
    * @see {@link remove} for unregistering a node
    * @see {@link has} for checking primary-key membership
    *
+   * @stability unstable
    * @category combinators
    * @since 3.19.0
    */
@@ -297,6 +306,7 @@ export const add: {
    * @see {@link remove} for unregistering a node
    * @see {@link has} for checking primary-key membership
    *
+   * @stability unstable
    * @category combinators
    * @since 3.19.0
    */
@@ -331,6 +341,7 @@ export const add: {
  * @see {@link add} for registering or updating a node
  * @see {@link has} for checking membership by primary key
  *
+ * @stability unstable
  * @category combinators
  * @since 3.19.0
  */
@@ -355,6 +366,7 @@ export const remove: {
    * @see {@link add} for registering or updating a node
    * @see {@link has} for checking membership by primary key
    *
+   * @stability unstable
    * @category combinators
    * @since 3.19.0
    */
@@ -379,6 +391,7 @@ export const remove: {
    * @see {@link add} for registering or updating a node
    * @see {@link has} for checking membership by primary key
    *
+   * @stability unstable
    * @category combinators
    * @since 3.19.0
    */
@@ -411,6 +424,7 @@ export const remove: {
  * @see {@link remove} for removing nodes by the same primary-key identity
  * @see {@link get} for routing an input string to a node
  *
+ * @stability unstable
  * @category combinators
  * @since 3.19.0
  */
@@ -432,6 +446,7 @@ export const has: {
    * @see {@link remove} for removing nodes by the same primary-key identity
    * @see {@link get} for routing an input string to a node
    *
+   * @stability unstable
    * @category combinators
    * @since 3.19.0
    */
@@ -453,6 +468,7 @@ export const has: {
    * @see {@link remove} for removing nodes by the same primary-key identity
    * @see {@link get} for routing an input string to a node
    *
+   * @stability unstable
    * @category combinators
    * @since 3.19.0
    */
@@ -474,6 +490,7 @@ export const has: {
  * @see {@link getShards} for assigning fixed shard indexes instead of routing
  * one input string at a time
  *
+ * @stability unstable
  * @category combinators
  * @since 3.19.0
  */
@@ -499,6 +516,7 @@ export const get = <A extends PrimaryKey.PrimaryKey>(self: HashRing<A>, input: s
  * Finite fractional values of `count` are rounded down. `NaN` and non-positive
  * values produce an empty shard distribution.
  *
+ * @stability unstable
  * @category combinators
  * @since 3.19.0
  */

package/src/HashSet.ts

@@ -7,6 +7,7 @@
  * union, intersection, difference, subset checks, mapping, filtering, and
  * reducing helpers.
  *
+ * @stability stable
  * @since 2.0.0
  */
 
@@ -45,6 +46,7 @@ const TypeId = internal.HashSetTypeId
  * smaller // => HashSet.make("apple", "cherry")
  * ```
  *
+ * @stability stable
  * @category models
  * @since 2.0.0
  */
@@ -74,6 +76,7 @@ export interface HashSet<out Value> extends Iterable<Value>, Equal, Pipeable, In
  * processFruit("apple") // => "Processing apple"
  * ```
  *
+ * @stability stable
  * @since 2.0.0
  */
 export declare namespace HashSet {
@@ -122,6 +125,7 @@ export declare namespace HashSet {
  * withValues // => HashSet.make("hello", "world")
  * ```
  *
+ * @stability stable
  * @category constructors
  * @since 2.0.0
  */
@@ -142,6 +146,7 @@ export const empty: <V = never>() => HashSet<V> = internal.empty
  * HashSet.make("hello", 42, true) // => HashSet.make("hello", 42, true)
  * ```
  *
+ * @stability stable
  * @category constructors
  * @since 2.0.0
  */
@@ -164,6 +169,7 @@ export const make: <Values extends ReadonlyArray<any>>(
  * HashSet.fromIterable("hello") // => HashSet.make("h", "e", "l", "o")
  * ```
  *
+ * @stability stable
  * @category constructors
  * @since 2.0.0
  */
@@ -185,6 +191,7 @@ export const fromIterable: <V>(values: Iterable<V>) => HashSet<V> = internal.fro
  * HashSet.isHashSet(null) // => false
  * ```
  *
+ * @stability stable
  * @category guards
  * @since 2.0.0
  */
@@ -205,6 +212,7 @@ export const isHashSet: {
    * HashSet.isHashSet(null) // => false
    * ```
    *
+   * @stability stable
    * @category guards
    * @since 2.0.0
    */
@@ -225,6 +233,7 @@ export const isHashSet: {
    * HashSet.isHashSet(null) // => false
    * ```
    *
+   * @stability stable
    * @category guards
    * @since 2.0.0
    */
@@ -250,6 +259,7 @@ export const isHashSet: {
  * HashSet.add(set, "a") // => HashSet.make("a", "b")
  * ```
  *
+ * @stability stable
  * @category mutations
  * @since 2.0.0
  */
@@ -273,6 +283,7 @@ export const add: {
    * HashSet.add(set, "a") // => HashSet.make("a", "b")
    * ```
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -296,6 +307,7 @@ export const add: {
    * HashSet.add(set, "a") // => HashSet.make("a", "b")
    * ```
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -336,6 +348,7 @@ export const add: {
  * HashSet.has(people, new Person("Alice")) // => true
  * ```
  *
+ * @stability stable
  * @category predicates
  * @since 2.0.0
  */
@@ -371,6 +384,7 @@ export const has: {
    * HashSet.has(people, new Person("Alice")) // => true
    * ```
    *
+   * @stability stable
    * @category predicates
    * @since 2.0.0
    */
@@ -406,6 +420,7 @@ export const has: {
    * HashSet.has(people, new Person("Alice")) // => true
    * ```
    *
+   * @stability stable
    * @category predicates
    * @since 2.0.0
    */
@@ -434,6 +449,7 @@ export const has: {
  * HashSet.remove(set, "d") // => HashSet.make("a", "b", "c")
  * ```
  *
+ * @stability stable
  * @category mutations
  * @since 2.0.0
  */
@@ -457,6 +473,7 @@ export const remove: {
    * HashSet.remove(set, "d") // => HashSet.make("a", "b", "c")
    * ```
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -480,6 +497,7 @@ export const remove: {
    * HashSet.remove(set, "d") // => HashSet.make("a", "b", "c")
    * ```
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -504,6 +522,7 @@ export const remove: {
  * HashSet.size(HashSet.fromIterable(["x", "y", "z", "x", "y"])) // => 3
  * ```
  *
+ * @stability stable
  * @category getters
  * @since 2.0.0
  */
@@ -522,6 +541,7 @@ export const size: <V>(self: HashSet<V>) => number = internal.size
  * HashSet.isEmpty(HashSet.make("a")) // => false
  * ```
  *
+ * @stability stable
  * @category predicates
  * @since 4.0.0
  */
@@ -538,6 +558,7 @@ export const isEmpty: <V>(self: HashSet<V>) => boolean = internal.isEmpty
  * HashSet.union(HashSet.make("a", "b"), HashSet.make("b", "c")) // => HashSet.make("a", "b", "c")
  * ```
  *
+ * @stability stable
  * @category combinators
  * @since 2.0.0
  */
@@ -553,6 +574,7 @@ export const union: {
    * HashSet.union(HashSet.make("a", "b"), HashSet.make("b", "c")) // => HashSet.make("a", "b", "c")
    * ```
    *
+   * @stability stable
    * @category combinators
    * @since 2.0.0
    */
@@ -568,6 +590,7 @@ export const union: {
    * HashSet.union(HashSet.make("a", "b"), HashSet.make("b", "c")) // => HashSet.make("a", "b", "c")
    * ```
    *
+   * @stability stable
    * @category combinators
    * @since 2.0.0
    */
@@ -588,6 +611,7 @@ export const union: {
  * HashSet.intersection(HashSet.make("a", "b", "c"), HashSet.make("b", "c", "d")) // => HashSet.make("b", "c")
  * ```
  *
+ * @stability stable
  * @category combinators
  * @since 2.0.0
  */
@@ -603,6 +627,7 @@ export const intersection: {
    * HashSet.intersection(HashSet.make("a", "b", "c"), HashSet.make("b", "c", "d")) // => HashSet.make("b", "c")
    * ```
    *
+   * @stability stable
    * @category combinators
    * @since 2.0.0
    */
@@ -618,6 +643,7 @@ export const intersection: {
    * HashSet.intersection(HashSet.make("a", "b", "c"), HashSet.make("b", "c", "d")) // => HashSet.make("b", "c")
    * ```
    *
+   * @stability stable
    * @category combinators
    * @since 2.0.0
    */
@@ -638,6 +664,7 @@ export const intersection: {
  * HashSet.difference(HashSet.make("a", "b", "c"), HashSet.make("b", "d")) // => HashSet.make("a", "c")
  * ```
  *
+ * @stability stable
  * @category combinators
  * @since 2.0.0
  */
@@ -653,6 +680,7 @@ export const difference: {
    * HashSet.difference(HashSet.make("a", "b", "c"), HashSet.make("b", "d")) // => HashSet.make("a", "c")
    * ```
    *
+   * @stability stable
    * @category combinators
    * @since 2.0.0
    */
@@ -668,6 +696,7 @@ export const difference: {
    * HashSet.difference(HashSet.make("a", "b", "c"), HashSet.make("b", "d")) // => HashSet.make("a", "c")
    * ```
    *
+   * @stability stable
    * @category combinators
    * @since 2.0.0
    */
@@ -695,6 +724,7 @@ export const difference: {
  * HashSet.isSubset(small, small) // => true
  * ```
  *
+ * @stability stable
  * @category predicates
  * @since 2.0.0
  */
@@ -717,6 +747,7 @@ export const isSubset: {
    * HashSet.isSubset(small, small) // => true
    * ```
    *
+   * @stability stable
    * @category predicates
    * @since 2.0.0
    */
@@ -739,6 +770,7 @@ export const isSubset: {
    * HashSet.isSubset(small, small) // => true
    * ```
    *
+   * @stability stable
    * @category predicates
    * @since 2.0.0
    */
@@ -767,6 +799,7 @@ export const isSubset: {
  * lengths // => HashSet.make(5, 6)
  * ```
  *
+ * @stability stable
  * @category mapping
  * @since 2.0.0
  */
@@ -790,6 +823,7 @@ export const map: {
    * lengths // => HashSet.make(5, 6)
    * ```
    *
+   * @stability stable
    * @category mapping
    * @since 2.0.0
    */
@@ -813,6 +847,7 @@ export const map: {
    * lengths // => HashSet.make(5, 6)
    * ```
    *
+   * @stability stable
    * @category mapping
    * @since 2.0.0
    */
@@ -833,6 +868,7 @@ export const map: {
  * HashSet.filter(HashSet.make(1, 2, 3, 4, 5, 6), (n) => n % 2 === 0) // => HashSet.make(2, 4, 6)
  * ```
  *
+ * @stability stable
  * @category filtering
  * @since 2.0.0
  */
@@ -848,6 +884,7 @@ export const filter: {
    * HashSet.filter(HashSet.make(1, 2, 3, 4, 5, 6), (n) => n % 2 === 0) // => HashSet.make(2, 4, 6)
    * ```
    *
+   * @stability stable
    * @category filtering
    * @since 2.0.0
    */
@@ -863,6 +900,7 @@ export const filter: {
    * HashSet.filter(HashSet.make(1, 2, 3, 4, 5, 6), (n) => n % 2 === 0) // => HashSet.make(2, 4, 6)
    * ```
    *
+   * @stability stable
    * @category filtering
    * @since 2.0.0
    */
@@ -878,6 +916,7 @@ export const filter: {
    * HashSet.filter(HashSet.make(1, 2, 3, 4, 5, 6), (n) => n % 2 === 0) // => HashSet.make(2, 4, 6)
    * ```
    *
+   * @stability stable
    * @category filtering
    * @since 2.0.0
    */
@@ -893,6 +932,7 @@ export const filter: {
    * HashSet.filter(HashSet.make(1, 2, 3, 4, 5, 6), (n) => n % 2 === 0) // => HashSet.make(2, 4, 6)
    * ```
    *
+   * @stability stable
    * @category filtering
    * @since 2.0.0
    */
@@ -910,6 +950,7 @@ export const filter: {
      * HashSet.filter(HashSet.make(1, 2, 3, 4, 5, 6), (n) => n % 2 === 0) // => HashSet.make(2, 4, 6)
      * ```
      *
+     * @stability stable
      * @category filtering
      * @since 2.0.0
      */
@@ -925,6 +966,7 @@ export const filter: {
      * HashSet.filter(HashSet.make(1, 2, 3, 4, 5, 6), (n) => n % 2 === 0) // => HashSet.make(2, 4, 6)
      * ```
      *
+     * @stability stable
      * @category filtering
      * @since 2.0.0
      */
@@ -942,6 +984,7 @@ export const filter: {
      * HashSet.filter(HashSet.make(1, 2, 3, 4, 5, 6), (n) => n % 2 === 0) // => HashSet.make(2, 4, 6)
      * ```
      *
+     * @stability stable
      * @category filtering
      * @since 2.0.0
      */
@@ -957,6 +1000,7 @@ export const filter: {
      * HashSet.filter(HashSet.make(1, 2, 3, 4, 5, 6), (n) => n % 2 === 0) // => HashSet.make(2, 4, 6)
      * ```
      *
+     * @stability stable
      * @category filtering
      * @since 2.0.0
      */
@@ -980,6 +1024,7 @@ export const filter: {
  * HashSet.some(HashSet.empty<number>(), (n) => n > 0) // => false
  * ```
  *
+ * @stability stable
  * @category predicates
  * @since 2.0.0
  */
@@ -1000,6 +1045,7 @@ export const some: {
    * HashSet.some(HashSet.empty<number>(), (n) => n > 0) // => false
    * ```
    *
+   * @stability stable
    * @category predicates
    * @since 2.0.0
    */
@@ -1020,6 +1066,7 @@ export const some: {
    * HashSet.some(HashSet.empty<number>(), (n) => n > 0) // => false
    * ```
    *
+   * @stability stable
    * @category predicates
    * @since 2.0.0
    */
@@ -1045,6 +1092,7 @@ export const some: {
  * HashSet.every(HashSet.empty<number>(), (n) => n > 0) // => true
  * ```
  *
+ * @stability stable
  * @category predicates
  * @since 2.0.0
  */
@@ -1065,6 +1113,7 @@ export const every: {
    * HashSet.every(HashSet.empty<number>(), (n) => n > 0) // => true
    * ```
    *
+   * @stability stable
    * @category predicates
    * @since 2.0.0
    */
@@ -1085,6 +1134,7 @@ export const every: {
    * HashSet.every(HashSet.empty<number>(), (n) => n > 0) // => true
    * ```
    *
+   * @stability stable
    * @category predicates
    * @since 2.0.0
    */
@@ -1106,6 +1156,7 @@ export const every: {
  * HashSet.reduce(numbers, 0, (acc, n) => acc + n) // => 15
  * ```
  *
+ * @stability stable
  * @category folding
  * @since 2.0.0
  */
@@ -1122,6 +1173,7 @@ export const reduce: {
    * HashSet.reduce(numbers, 0, (acc, n) => acc + n) // => 15
    * ```
    *
+   * @stability stable
    * @category folding
    * @since 2.0.0
    */
@@ -1138,6 +1190,7 @@ export const reduce: {
    * HashSet.reduce(numbers, 0, (acc, n) => acc + n) // => 15
    * ```
    *
+   * @stability stable
    * @category folding
    * @since 2.0.0
    */

package/src/Inspectable.ts

@@ -7,6 +7,7 @@
  * the `Inspectable` interface, safe conversion helpers, and shared prototype or
  * class implementations for custom values.
  *
+ * @stability stable
  * @since 2.0.0
  */
 import { format, formatJson } from "./Formatter.ts"
@@ -43,6 +44,7 @@ import { redact } from "./Redactable.ts"
  * obj[Inspectable.NodeInspectSymbol]() // => "CustomObject(hello)"
  * ```
  *
+ * @stability stable
  * @category symbols
  * @since 2.0.0
  */
@@ -74,6 +76,7 @@ export const NodeInspectSymbol = Symbol.for("nodejs.util.inspect.custom")
  * obj[Inspectable.NodeInspectSymbol]() // => "CustomObject(test)"
  * ```
  *
+ * @stability stable
  * @category symbols
  * @since 2.0.0
  */
@@ -120,6 +123,7 @@ export type NodeInspectSymbol = typeof NodeInspectSymbol
  * success.toString() // => "{\"_tag\":\"Success\",\"value\":42}"
  * ```
  *
+ * @stability stable
  * @category models
  * @since 2.0.0
  */
@@ -147,6 +151,7 @@ export interface Inspectable {
  *
  * @see {@link toStringUnknown} for converting unknown values to strings
  *
+ * @stability stable
  * @category converting
  * @since 4.0.0
  */
@@ -181,6 +186,7 @@ export const toJson = (input: unknown): unknown => {
  * provided whitespace setting when possible, and values that cannot be
  * formatted are converted with `String`.
  *
+ * @stability stable
  * @category converting
  * @since 2.0.0
  */
@@ -228,6 +234,7 @@ export const toStringUnknown = (u: unknown, whitespace: number | string | undefi
  * MyClass.prototype.constructor = MyClass
  * ```
  *
+ * @stability stable
  * @category prototypes
  * @since 2.0.0
  */
@@ -285,6 +292,7 @@ export const BaseProto: Inspectable = {
  * user[Inspectable.NodeInspectSymbol]() // => { _tag: "User", id: 1, name: "Alice", email: "alice@example.com" }
  * ```
  *
+ * @stability stable
  * @category models
  * @since 2.0.0
  */