effect 4.0.0 → 4.0.2

package/src/Tuple.ts

@@ -8,6 +8,7 @@
  * typed positions, and deriving comparison or combination helpers for tuple
  * shapes.
  *
+ * @stability stable
  * @since 2.0.0
  */
 import * as Combiner from "./Combiner.ts"
@@ -40,6 +41,7 @@ import type { Apply, Lambda } from "./Struct.ts"
  *
  * @see {@link get} – access a single element by index
  * @see {@link appendElement} – append an element to a tuple
+ * @stability stable
  * @category constructors
  * @since 2.0.0
  */
@@ -69,6 +71,7 @@ type Indices<T extends ReadonlyArray<unknown>> = Exclude<Partial<T>["length"], T
  *
  * @see {@link make} – create a tuple
  * @see {@link pick} – extract multiple elements into a new tuple
+ * @stability stable
  * @category getters
  * @since 4.0.0
  */
@@ -94,6 +97,7 @@ export const get: {
    *
    * @see {@link make} – create a tuple
    * @see {@link pick} – extract multiple elements into a new tuple
+   * @stability stable
    * @category getters
    * @since 4.0.0
    */
@@ -119,6 +123,7 @@ export const get: {
    *
    * @see {@link make} – create a tuple
    * @see {@link pick} – extract multiple elements into a new tuple
+   * @stability stable
    * @category getters
    * @since 4.0.0
    */
@@ -164,6 +169,7 @@ type PickTuple<T extends ReadonlyArray<unknown>, I extends ReadonlyArray<Indices
  *
  * @see {@link omit} – the inverse (exclude indices instead)
  * @see {@link get} – extract a single element
+ * @stability stable
  * @category filtering
  * @since 4.0.0
  */
@@ -189,6 +195,7 @@ export const pick: {
    *
    * @see {@link omit} – the inverse (exclude indices instead)
    * @see {@link get} – extract a single element
+   * @stability stable
    * @category filtering
    * @since 4.0.0
    */
@@ -214,6 +221,7 @@ export const pick: {
    *
    * @see {@link omit} – the inverse (exclude indices instead)
    * @see {@link get} – extract a single element
+   * @stability stable
    * @category filtering
    * @since 4.0.0
    */
@@ -250,6 +258,7 @@ type OmitTuple<T extends ReadonlyArray<unknown>, K> = _BuildTuple<T, Exclude<Ind
  * ```
  *
  * @see {@link pick} – the inverse (keep only specified indices)
+ * @stability stable
  * @category filtering
  * @since 4.0.0
  */
@@ -274,6 +283,7 @@ export const omit: {
    * ```
    *
    * @see {@link pick} – the inverse (keep only specified indices)
+   * @stability stable
    * @category filtering
    * @since 4.0.0
    */
@@ -298,6 +308,7 @@ export const omit: {
    * ```
    *
    * @see {@link pick} – the inverse (keep only specified indices)
+   * @stability stable
    * @category filtering
    * @since 4.0.0
    */
@@ -334,6 +345,7 @@ export const omit: {
  * ```
  *
  * @see {@link appendElements} – append multiple elements (another tuple)
+ * @stability stable
  * @category combining
  * @since 2.0.0
  */
@@ -359,6 +371,7 @@ export const appendElement: {
    * ```
    *
    * @see {@link appendElements} – append multiple elements (another tuple)
+   * @stability stable
    * @category combining
    * @since 2.0.0
    */
@@ -384,6 +397,7 @@ export const appendElement: {
    * ```
    *
    * @see {@link appendElements} – append multiple elements (another tuple)
+   * @stability stable
    * @category combining
    * @since 2.0.0
    */
@@ -411,6 +425,7 @@ export const appendElement: {
  * ```
  *
  * @see {@link appendElement} – append a single element
+ * @stability stable
  * @category combining
  * @since 4.0.0
  */
@@ -436,6 +451,7 @@ export const appendElements: {
    * ```
    *
    * @see {@link appendElement} – append a single element
+   * @stability stable
    * @category combining
    * @since 4.0.0
    */
@@ -461,6 +477,7 @@ export const appendElements: {
    * ```
    *
    * @see {@link appendElement} – append a single element
+   * @stability stable
    * @category combining
    * @since 4.0.0
    */
@@ -509,6 +526,7 @@ type Evolved<T, E> = { [I in keyof T]: I extends keyof E ? EvolveElement<T[I], E
  *
  * @see {@link map} – apply the same transformation to all elements
  * @see {@link renameIndices} – swap element positions
+ * @stability stable
  * @category mapping
  * @since 4.0.0
  */
@@ -543,6 +561,7 @@ export const evolve: {
    *
    * @see {@link map} – apply the same transformation to all elements
    * @see {@link renameIndices} – swap element positions
+   * @stability stable
    * @category mapping
    * @since 4.0.0
    */
@@ -577,6 +596,7 @@ export const evolve: {
    *
    * @see {@link map} – apply the same transformation to all elements
    * @see {@link renameIndices} – swap element positions
+   * @stability stable
    * @category mapping
    * @since 4.0.0
    */
@@ -617,6 +637,7 @@ export const evolve: {
  * ```
  *
  * @see {@link evolve} – transform element values instead of positions
+ * @stability stable
  * @category transforming
  * @since 4.0.0
  */
@@ -650,6 +671,7 @@ export const renameIndices: {
    * ```
    *
    * @see {@link evolve} – transform element values instead of positions
+   * @stability stable
    * @category transforming
    * @since 4.0.0
    */
@@ -683,6 +705,7 @@ export const renameIndices: {
    * ```
    *
    * @see {@link evolve} – transform element values instead of positions
+   * @stability stable
    * @category transforming
    * @since 4.0.0
    */
@@ -730,6 +753,7 @@ export const renameIndices: {
  * @see {@link mapPick} – apply a lambda only to selected indices
  * @see {@link mapOmit} – apply a lambda to all indices except selected ones
  * @see {@link evolve} – apply different functions to different indices
+ * @stability stable
  * @category mapping
  * @since 3.9.0
  */
@@ -767,6 +791,7 @@ export const map: {
    * @see {@link mapPick} – apply a lambda only to selected indices
    * @see {@link mapOmit} – apply a lambda to all indices except selected ones
    * @see {@link evolve} – apply different functions to different indices
+   * @stability stable
    * @category mapping
    * @since 3.9.0
    */
@@ -806,6 +831,7 @@ export const map: {
    * @see {@link mapPick} – apply a lambda only to selected indices
    * @see {@link mapOmit} – apply a lambda to all indices except selected ones
    * @see {@link evolve} – apply different functions to different indices
+   * @stability stable
    * @category mapping
    * @since 3.9.0
    */
@@ -845,6 +871,7 @@ export const map: {
  *
  * @see {@link map} – apply a lambda to all elements
  * @see {@link mapOmit} – apply a lambda to all elements except selected ones
+ * @stability stable
  * @category mapping
  * @since 4.0.0
  */
@@ -877,6 +904,7 @@ export const mapPick: {
    *
    * @see {@link map} – apply a lambda to all elements
    * @see {@link mapOmit} – apply a lambda to all elements except selected ones
+   * @stability stable
    * @category mapping
    * @since 4.0.0
    */
@@ -911,6 +939,7 @@ export const mapPick: {
    *
    * @see {@link map} – apply a lambda to all elements
    * @see {@link mapOmit} – apply a lambda to all elements except selected ones
+   * @stability stable
    * @category mapping
    * @since 4.0.0
    */
@@ -955,6 +984,7 @@ export const mapPick: {
  *
  * @see {@link map} – apply a lambda to all elements
  * @see {@link mapPick} – apply a lambda only to selected indices
+ * @stability stable
  * @category mapping
  * @since 4.0.0
  */
@@ -987,6 +1017,7 @@ export const mapOmit: {
    *
    * @see {@link map} – apply a lambda to all elements
    * @see {@link mapPick} – apply a lambda only to selected indices
+   * @stability stable
    * @category mapping
    * @since 4.0.0
    */
@@ -1021,6 +1052,7 @@ export const mapOmit: {
    *
    * @see {@link map} – apply a lambda to all elements
    * @see {@link mapPick} – apply a lambda only to selected indices
+   * @stability stable
    * @category mapping
    * @since 4.0.0
    */
@@ -1065,6 +1097,7 @@ export const mapOmit: {
  * ```
  *
  * @see {@link makeOrder} – create an `Order` for tuples
+ * @stability stable
  * @category instances
  * @since 4.0.0
  */
@@ -1096,6 +1129,7 @@ export const makeEquivalence = Equivalence.Tuple
  * ```
  *
  * @see {@link makeEquivalence} – create an `Equivalence` for tuples
+ * @stability stable
  * @category ordering
  * @since 4.0.0
  */
@@ -1132,6 +1166,7 @@ export {
    * ```
    *
    * @see `isTupleOfAtLeast` – check for a minimum length
+   * @stability stable
    * @category guards
    * @since 3.3.0
    */
@@ -1166,6 +1201,7 @@ export {
    * ```
    *
    * @see `isTupleOf` – check for an exact length
+   * @stability stable
    * @category guards
    * @since 3.3.0
    */
@@ -1196,6 +1232,7 @@ export {
  * ```
  *
  * @see {@link makeReducer} – like `makeCombiner` but with an initial value
+ * @stability stable
  * @category combining
  * @since 4.0.0
  */
@@ -1240,6 +1277,7 @@ export function makeCombiner<A extends ReadonlyArray<unknown>>(
  * ```
  *
  * @see {@link makeCombiner} – like `makeReducer` but without an initial value
+ * @stability stable
  * @category folding
  * @since 4.0.0
  */

package/src/TxChunk.ts

@@ -8,6 +8,7 @@
  * removing values, checking size, slicing, mapping, filtering, and combining
  * chunks.
  *
+ * @stability unstable
  * @since 4.0.0
  */
 import * as Chunk from "./Chunk.ts"
@@ -66,6 +67,7 @@ const TypeId = "~effect/TxChunk"
  * await Effect.runPromise(program) // => [[1, 2, 3, 4], [0, 1, 2, 3, 4, 5]]
  * ```
  *
+ * @stability unstable
  * @category models
  * @since 4.0.0
  */
@@ -118,6 +120,7 @@ const TxChunkProto = {
  * await Effect.runPromise(program) // => [1, 2, 3]
  * ```
  *
+ * @stability unstable
  * @category constructors
  * @since 4.0.0
  */
@@ -154,6 +157,7 @@ export const make = <A>(initial: Chunk.Chunk<A>): Effect.Effect<TxChunk<A>> =>
  * await Effect.runPromise(program) // => [true, false]
  * ```
  *
+ * @stability unstable
  * @category constructors
  * @since 4.0.0
  */
@@ -195,6 +199,7 @@ export const empty = <A = never>(): Effect.Effect<TxChunk<A>> =>
  * await Effect.runPromise(program) // => [[1, 2, 3, 4, 5], [0, 1, 2, 3, 4, 5, 6]]
  * ```
  *
+ * @stability unstable
  * @category constructors
  * @since 4.0.0
  */
@@ -220,6 +225,7 @@ export const fromIterable = <A>(iterable: Iterable<A>): Effect.Effect<TxChunk<A>
  * Chunk.toArray(await Effect.runPromise(TxChunk.get(txChunk))) // => [1, 2, 3]
  * ```
  *
+ * @stability unstable
  * @category constructors
  * @since 4.0.0
  */
@@ -244,6 +250,7 @@ export const makeUnsafe = <A>(ref: TxRef.TxRef<Chunk.Chunk<A>>): TxChunk<A> => {
  * TxChunk.isTxChunk(Chunk.empty()) // => false
  * ```
  *
+ * @stability unstable
  * @category guards
  * @since 4.0.0
  */
@@ -278,6 +285,7 @@ export const isTxChunk = (u: unknown): u is TxChunk<unknown> => hasProperty(u, T
  * await Effect.runPromise(program) // => [3, [1, 2, 3, 4]]
  * ```
  *
+ * @stability unstable
  * @category combinators
  * @since 4.0.0
  */
@@ -311,6 +319,7 @@ export const modify: {
    * await Effect.runPromise(program) // => [3, [1, 2, 3, 4]]
    * ```
    *
+   * @stability unstable
    * @category combinators
    * @since 4.0.0
    */
@@ -346,6 +355,7 @@ export const modify: {
    * await Effect.runPromise(program) // => [3, [1, 2, 3, 4]]
    * ```
    *
+   * @stability unstable
    * @category combinators
    * @since 4.0.0
    */
@@ -387,6 +397,7 @@ export const modify: {
  * await Effect.runPromise(program) // => [3, 2, 1]
  * ```
  *
+ * @stability unstable
  * @category combinators
  * @since 4.0.0
  */
@@ -417,6 +428,7 @@ export const update: {
    * await Effect.runPromise(program) // => [3, 2, 1]
    * ```
    *
+   * @stability unstable
    * @category combinators
    * @since 4.0.0
    */
@@ -447,6 +459,7 @@ export const update: {
    * await Effect.runPromise(program) // => [3, 2, 1]
    * ```
    *
+   * @stability unstable
    * @category combinators
    * @since 4.0.0
    */
@@ -478,6 +491,7 @@ export const update: {
  * await Effect.runPromise(program) // => [[1, 2, 3], 3]
  * ```
  *
+ * @stability unstable
  * @category combinators
  * @since 4.0.0
  */
@@ -510,6 +524,7 @@ export const get = <A>(self: TxChunk<A>): Effect.Effect<Chunk.Chunk<A>> => TxRef
  * await Effect.runPromise(program) // => [10, 20, 30, 40]
  * ```
  *
+ * @stability unstable
  * @category combinators
  * @since 4.0.0
  */
@@ -541,6 +556,7 @@ export const set: {
    * await Effect.runPromise(program) // => [10, 20, 30, 40]
    * ```
    *
+   * @stability unstable
    * @category combinators
    * @since 4.0.0
    */
@@ -572,6 +588,7 @@ export const set: {
    * await Effect.runPromise(program) // => [10, 20, 30, 40]
    * ```
    *
+   * @stability unstable
    * @category combinators
    * @since 4.0.0
    */
@@ -607,6 +624,7 @@ export const set: {
  * await Effect.runPromise(program) // => [1, 2, 3, 4]
  * ```
  *
+ * @stability unstable
  * @category combinators
  * @since 4.0.0
  */
@@ -637,6 +655,7 @@ export const append: {
    * await Effect.runPromise(program) // => [1, 2, 3, 4]
    * ```
    *
+   * @stability unstable
    * @category combinators
    * @since 4.0.0
    */
@@ -667,6 +686,7 @@ export const append: {
    * await Effect.runPromise(program) // => [1, 2, 3, 4]
    * ```
    *
+   * @stability unstable
    * @category combinators
    * @since 4.0.0
    */
@@ -702,6 +722,7 @@ export const append: {
  * await Effect.runPromise(program) // => [1, 2, 3, 4]
  * ```
  *
+ * @stability unstable
  * @category combinators
  * @since 4.0.0
  */
@@ -732,6 +753,7 @@ export const prepend: {
    * await Effect.runPromise(program) // => [1, 2, 3, 4]
    * ```
    *
+   * @stability unstable
    * @category combinators
    * @since 4.0.0
    */
@@ -762,6 +784,7 @@ export const prepend: {
    * await Effect.runPromise(program) // => [1, 2, 3, 4]
    * ```
    *
+   * @stability unstable
    * @category combinators
    * @since 4.0.0
    */
@@ -794,6 +817,7 @@ export const prepend: {
  * await Effect.runPromise(program) // => [5, 6]
  * ```
  *
+ * @stability unstable
  * @category combinators
  * @since 4.0.0
  */
@@ -822,6 +846,7 @@ export const size = <A>(self: TxChunk<A>): Effect.Effect<number> =>
  * await Effect.runPromise(program) // => [true, false]
  * ```
  *
+ * @stability unstable
  * @category predicates
  * @since 4.0.0
  */
@@ -850,6 +875,7 @@ export const isEmpty = <A>(self: TxChunk<A>): Effect.Effect<boolean> =>
  * await Effect.runPromise(program) // => [false, true]
  * ```
  *
+ * @stability unstable
  * @category predicates
  * @since 4.0.0
  */
@@ -882,6 +908,7 @@ export const isNonEmpty = <A>(self: TxChunk<A>): Effect.Effect<boolean> =>
  * await Effect.runPromise(program) // => [1, 2, 3]
  * ```
  *
+ * @stability unstable
  * @category combinators
  * @since 4.0.0
  */
@@ -912,6 +939,7 @@ export const take: {
    * await Effect.runPromise(program) // => [1, 2, 3]
    * ```
    *
+   * @stability unstable
    * @category combinators
    * @since 4.0.0
    */
@@ -942,6 +970,7 @@ export const take: {
    * await Effect.runPromise(program) // => [1, 2, 3]
    * ```
    *
+   * @stability unstable
    * @category combinators
    * @since 4.0.0
    */
@@ -977,6 +1006,7 @@ export const take: {
  * await Effect.runPromise(program) // => [3, 4, 5]
  * ```
  *
+ * @stability unstable
  * @category combinators
  * @since 4.0.0
  */
@@ -1007,6 +1037,7 @@ export const drop: {
    * await Effect.runPromise(program) // => [3, 4, 5]
    * ```
    *
+   * @stability unstable
    * @category combinators
    * @since 4.0.0
    */
@@ -1037,6 +1068,7 @@ export const drop: {
    * await Effect.runPromise(program) // => [3, 4, 5]
    * ```
    *
+   * @stability unstable
    * @category combinators
    * @since 4.0.0
    */
@@ -1072,6 +1104,7 @@ export const drop: {
  * await Effect.runPromise(program) // => [3, 4, 5]
  * ```
  *
+ * @stability unstable
  * @category combinators
  * @since 4.0.0
  */
@@ -1102,6 +1135,7 @@ export const slice: {
    * await Effect.runPromise(program) // => [3, 4, 5]
    * ```
    *
+   * @stability unstable
    * @category combinators
    * @since 4.0.0
    */
@@ -1132,6 +1166,7 @@ export const slice: {
    * await Effect.runPromise(program) // => [3, 4, 5]
    * ```
    *
+   * @stability unstable
    * @category combinators
    * @since 4.0.0
    */
@@ -1169,6 +1204,7 @@ export const slice: {
  * await Effect.runPromise(program) // => [2, 4, 6, 8]
  * ```
  *
+ * @stability unstable
  * @category combinators
  * @since 4.0.0
  */
@@ -1200,6 +1236,7 @@ export const map: {
    * await Effect.runPromise(program) // => [2, 4, 6, 8]
    * ```
    *
+   * @stability unstable
    * @category combinators
    * @since 4.0.0
    */
@@ -1231,6 +1268,7 @@ export const map: {
    * await Effect.runPromise(program) // => [2, 4, 6, 8]
    * ```
    *
+   * @stability unstable
    * @category combinators
    * @since 4.0.0
    */
@@ -1266,6 +1304,7 @@ export const map: {
  * await Effect.runPromise(program) // => [2, 4, 6]
  * ```
  *
+ * @stability unstable
  * @category combinators
  * @since 4.0.0
  */
@@ -1296,6 +1335,7 @@ export const filter: {
    * await Effect.runPromise(program) // => [2, 4, 6]
    * ```
    *
+   * @stability unstable
    * @category combinators
    * @since 4.0.0
    */
@@ -1326,6 +1366,7 @@ export const filter: {
    * await Effect.runPromise(program) // => [2, 4, 6]
    * ```
    *
+   * @stability unstable
    * @category combinators
    * @since 4.0.0
    */
@@ -1356,6 +1397,7 @@ export const filter: {
    * await Effect.runPromise(program) // => [2, 4, 6]
    * ```
    *
+   * @stability unstable
    * @category combinators
    * @since 4.0.0
    */
@@ -1386,6 +1428,7 @@ export const filter: {
    * await Effect.runPromise(program) // => [2, 4, 6]
    * ```
    *
+   * @stability unstable
    * @category combinators
    * @since 4.0.0
    */
@@ -1423,6 +1466,7 @@ export const filter: {
  * await Effect.runPromise(program) // => [1, 2, 3, 4, 5, 6]
  * ```
  *
+ * @stability unstable
  * @category combinators
  * @since 4.0.0
  */
@@ -1454,6 +1498,7 @@ export const appendAll: {
    * await Effect.runPromise(program) // => [1, 2, 3, 4, 5, 6]
    * ```
    *
+   * @stability unstable
    * @category combinators
    * @since 4.0.0
    */
@@ -1485,6 +1530,7 @@ export const appendAll: {
    * await Effect.runPromise(program) // => [1, 2, 3, 4, 5, 6]
    * ```
    *
+   * @stability unstable
    * @category combinators
    * @since 4.0.0
    */
@@ -1522,6 +1568,7 @@ export const appendAll: {
  * await Effect.runPromise(program) // => [1, 2, 3, 4, 5, 6]
  * ```
  *
+ * @stability unstable
  * @category combinators
  * @since 4.0.0
  */
@@ -1553,6 +1600,7 @@ export const prependAll: {
    * await Effect.runPromise(program) // => [1, 2, 3, 4, 5, 6]
    * ```
    *
+   * @stability unstable
    * @category combinators
    * @since 4.0.0
    */
@@ -1584,6 +1632,7 @@ export const prependAll: {
    * await Effect.runPromise(program) // => [1, 2, 3, 4, 5, 6]
    * ```
    *
+   * @stability unstable
    * @category combinators
    * @since 4.0.0
    */
@@ -1624,6 +1673,7 @@ export const prependAll: {
  * await Effect.runPromise(program) // => [[1, 2, 3, 4, 5, 6], [4, 5, 6]]
  * ```
  *
+ * @stability unstable
  * @category combinators
  * @since 4.0.0
  */
@@ -1658,6 +1708,7 @@ export const concat: {
    * await Effect.runPromise(program) // => [[1, 2, 3, 4, 5, 6], [4, 5, 6]]
    * ```
    *
+   * @stability unstable
    * @category combinators
    * @since 4.0.0
    */
@@ -1692,6 +1743,7 @@ export const concat: {
    * await Effect.runPromise(program) // => [[1, 2, 3, 4, 5, 6], [4, 5, 6]]
    * ```
    *
+   * @stability unstable
    * @category combinators
    * @since 4.0.0
    */