effect 4.0.0 → 4.0.2

package/src/Struct.ts

@@ -8,6 +8,7 @@
  * list of keys. The module also includes type-level helpers for simplifying and
  * merging object shapes.
  *
+ * @stability stable
  * @since 2.0.0
  */
 
@@ -46,6 +47,7 @@ import * as Reducer from "./Reducer.ts"
  *
  * @see {@link Mutable} – also flattens but removes `readonly`
  * @see {@link Assign} – merges two types with right-side precedence
+ * @stability stable
  * @category utility types
  * @since 4.0.0
  */
@@ -78,6 +80,7 @@ export type Simplify<T> = { [K in keyof T]: T[K] } & {}
  * ```
  *
  * @see {@link Simplify} – flattens intersections without removing `readonly`
+ * @stability stable
  * @category utility types
  * @since 4.0.0
  */
@@ -111,6 +114,7 @@ export type Mutable<T> = { -readonly [K in keyof T]: T[K] } & {}
  *
  * @see {@link assign} – the runtime equivalent
  * @see {@link Simplify} – flatten the resulting intersection
+ * @stability stable
  * @category utility types
  * @since 4.0.0
  */
@@ -137,6 +141,7 @@ export type Assign<T, U> = Simplify<keyof T & keyof U extends never ? T & U : Om
  *
  * @see {@link keys} – list all string keys of a struct
  * @see {@link pick} – extract multiple properties into a new struct
+ * @stability stable
  * @category getters
  * @since 2.0.0
  */
@@ -162,6 +167,7 @@ export const get: {
    *
    * @see {@link keys} – list all string keys of a struct
    * @see {@link pick} – extract multiple properties into a new struct
+   * @stability stable
    * @category getters
    * @since 2.0.0
    */
@@ -187,6 +193,7 @@ export const get: {
    *
    * @see {@link keys} – list all string keys of a struct
    * @see {@link pick} – extract multiple properties into a new struct
+   * @stability stable
    * @category getters
    * @since 2.0.0
    */
@@ -218,6 +225,7 @@ export const get: {
  *
  * @see {@link get} – access a single key's value
  * @see {@link pick} – select a subset of keys into a new struct
+ * @stability stable
  * @category getters
  * @since 3.6.0
  */
@@ -246,6 +254,7 @@ export const keys = <S extends object>(self: S): Array<(keyof S) & string> =>
  *
  * @see {@link omit} – the inverse (exclude keys instead)
  * @see {@link get} – extract a single value
+ * @stability stable
  * @category filtering
  * @since 2.0.0
  */
@@ -272,6 +281,7 @@ export const pick: {
    *
    * @see {@link omit} – the inverse (exclude keys instead)
    * @see {@link get} – extract a single value
+   * @stability stable
    * @category filtering
    * @since 2.0.0
    */
@@ -298,6 +308,7 @@ export const pick: {
    *
    * @see {@link omit} – the inverse (exclude keys instead)
    * @see {@link get} – extract a single value
+   * @stability stable
    * @category filtering
    * @since 2.0.0
    */
@@ -330,6 +341,7 @@ export const pick: {
  * ```
  *
  * @see {@link pick} – the inverse (keep only specified keys)
+ * @stability stable
  * @category filtering
  * @since 2.0.0
  */
@@ -355,6 +367,7 @@ export const omit: {
    * ```
    *
    * @see {@link pick} – the inverse (keep only specified keys)
+   * @stability stable
    * @category filtering
    * @since 2.0.0
    */
@@ -380,6 +393,7 @@ export const omit: {
    * ```
    *
    * @see {@link pick} – the inverse (keep only specified keys)
+   * @stability stable
    * @category filtering
    * @since 2.0.0
    */
@@ -415,6 +429,7 @@ export const omit: {
  *
  * @see {@link Assign} – the type-level equivalent
  * @see {@link evolve} – transform individual values instead of replacing them
+ * @stability stable
  * @category combining
  * @since 4.0.0
  */
@@ -443,6 +458,7 @@ export const assign: {
    *
    * @see {@link Assign} – the type-level equivalent
    * @see {@link evolve} – transform individual values instead of replacing them
+   * @stability stable
    * @category combining
    * @since 4.0.0
    */
@@ -471,6 +487,7 @@ export const assign: {
    *
    * @see {@link Assign} – the type-level equivalent
    * @see {@link evolve} – transform individual values instead of replacing them
+   * @stability stable
    * @category combining
    * @since 4.0.0
    */
@@ -519,6 +536,7 @@ type Evolved<S, E> = Simplify<
  * @see {@link evolveKeys} – transform keys instead of values
  * @see {@link evolveEntries} – transform both keys and values
  * @see {@link map} – apply the same transformation to all values
+ * @stability stable
  * @category transforming
  * @since 2.0.0
  */
@@ -554,6 +572,7 @@ export const evolve: {
    * @see {@link evolveKeys} – transform keys instead of values
    * @see {@link evolveEntries} – transform both keys and values
    * @see {@link map} – apply the same transformation to all values
+   * @stability stable
    * @category transforming
    * @since 2.0.0
    */
@@ -589,6 +608,7 @@ export const evolve: {
    * @see {@link evolveKeys} – transform keys instead of values
    * @see {@link evolveEntries} – transform both keys and values
    * @see {@link map} – apply the same transformation to all values
+   * @stability stable
    * @category transforming
    * @since 2.0.0
    */
@@ -636,6 +656,7 @@ type KeyEvolved<S, E> = Simplify<
  * @see {@link renameKeys} – rename keys with a static mapping
  * @see {@link evolve} – transform values instead of keys
  * @see {@link evolveEntries} – transform both keys and values
+ * @stability stable
  * @category transforming
  * @since 4.0.0
  */
@@ -670,6 +691,7 @@ export const evolveKeys: {
    * @see {@link renameKeys} – rename keys with a static mapping
    * @see {@link evolve} – transform values instead of keys
    * @see {@link evolveEntries} – transform both keys and values
+   * @stability stable
    * @category transforming
    * @since 4.0.0
    */
@@ -704,6 +726,7 @@ export const evolveKeys: {
    * @see {@link renameKeys} – rename keys with a static mapping
    * @see {@link evolve} – transform values instead of keys
    * @see {@link evolveEntries} – transform both keys and values
+   * @stability stable
    * @category transforming
    * @since 4.0.0
    */
@@ -757,6 +780,7 @@ type EntryEvolved<S, E> = {
  *
  * @see {@link evolve} – transform values only
  * @see {@link evolveKeys} – transform keys only
+ * @stability stable
  * @category transforming
  * @since 4.0.0
  */
@@ -791,6 +815,7 @@ export const evolveEntries: {
    *
    * @see {@link evolve} – transform values only
    * @see {@link evolveKeys} – transform keys only
+   * @stability stable
    * @category transforming
    * @since 4.0.0
    */
@@ -825,6 +850,7 @@ export const evolveEntries: {
    *
    * @see {@link evolve} – transform values only
    * @see {@link evolveKeys} – transform keys only
+   * @stability stable
    * @category transforming
    * @since 4.0.0
    */
@@ -862,6 +888,7 @@ export const evolveEntries: {
  *
  * @see {@link evolveKeys} – rename keys using functions
  * @see {@link evolveEntries} – rename keys and transform values
+ * @stability stable
  * @category transforming
  * @since 4.0.0
  */
@@ -892,6 +919,7 @@ export const renameKeys: {
    *
    * @see {@link evolveKeys} – rename keys using functions
    * @see {@link evolveEntries} – rename keys and transform values
+   * @stability stable
    * @category transforming
    * @since 4.0.0
    */
@@ -922,6 +950,7 @@ export const renameKeys: {
    *
    * @see {@link evolveKeys} – rename keys using functions
    * @see {@link evolveEntries} – rename keys and transform values
+   * @stability stable
    * @category transforming
    * @since 4.0.0
    */
@@ -961,6 +990,7 @@ export const renameKeys: {
  * ```
  *
  * @see {@link makeOrder} – create an `Order` for structs
+ * @stability stable
  * @category instances
  * @since 4.0.0
  */
@@ -995,6 +1025,7 @@ export const makeEquivalence = Equivalence.Struct
  * ```
  *
  * @see {@link makeEquivalence} – create an `Equivalence` for structs
+ * @stability stable
  * @category ordering
  * @since 4.0.0
  */
@@ -1030,6 +1061,7 @@ export const makeOrder = order.Struct
  * @see {@link Apply} – apply a Lambda to a concrete type
  * @see {@link lambda} – create a runtime lambda value
  * @see {@link map} – use a lambda to transform all struct values
+ * @stability stable
  * @category utility types
  * @since 4.0.0
  */
@@ -1068,6 +1100,7 @@ export interface Lambda {
  * ```
  *
  * @see {@link Lambda} – the base interface
+ * @stability stable
  * @category utility types
  * @since 4.0.0
  */
@@ -1106,6 +1139,7 @@ export type Apply<L extends Lambda, V> = (L & { readonly "~lambda.in": V })["~la
  *
  * @see {@link Lambda} – the type-level interface
  * @see {@link map} – apply a lambda to all struct values
+ * @stability stable
  * @category constructors
  * @since 4.0.0
  */
@@ -1143,6 +1177,7 @@ export const lambda = <L extends (a: any) => any>(
  * @see {@link mapPick} – apply a lambda only to selected keys
  * @see {@link mapOmit} – apply a lambda to all keys except selected ones
  * @see {@link evolve} – apply different functions to different keys
+ * @stability stable
  * @category mapping
  * @since 4.0.0
  */
@@ -1177,6 +1212,7 @@ export const map: {
    * @see {@link mapPick} – apply a lambda only to selected keys
    * @see {@link mapOmit} – apply a lambda to all keys except selected ones
    * @see {@link evolve} – apply different functions to different keys
+   * @stability stable
    * @category mapping
    * @since 4.0.0
    */
@@ -1211,6 +1247,7 @@ export const map: {
    * @see {@link mapPick} – apply a lambda only to selected keys
    * @see {@link mapOmit} – apply a lambda to all keys except selected ones
    * @see {@link evolve} – apply different functions to different keys
+   * @stability stable
    * @category mapping
    * @since 4.0.0
    */
@@ -1250,6 +1287,7 @@ export const map: {
  *
  * @see {@link map} – apply a lambda to all keys
  * @see {@link mapOmit} – apply a lambda to all keys except selected ones
+ * @stability stable
  * @category mapping
  * @since 4.0.0
  */
@@ -1282,6 +1320,7 @@ export const mapPick: {
    *
    * @see {@link map} – apply a lambda to all keys
    * @see {@link mapOmit} – apply a lambda to all keys except selected ones
+   * @stability stable
    * @category mapping
    * @since 4.0.0
    */
@@ -1316,6 +1355,7 @@ export const mapPick: {
    *
    * @see {@link map} – apply a lambda to all keys
    * @see {@link mapOmit} – apply a lambda to all keys except selected ones
+   * @stability stable
    * @category mapping
    * @since 4.0.0
    */
@@ -1359,6 +1399,7 @@ export const mapPick: {
  *
  * @see {@link map} – apply a lambda to all keys
  * @see {@link mapPick} – apply a lambda only to selected keys
+ * @stability stable
  * @category mapping
  * @since 4.0.0
  */
@@ -1391,6 +1432,7 @@ export const mapOmit: {
    *
    * @see {@link map} – apply a lambda to all keys
    * @see {@link mapPick} – apply a lambda only to selected keys
+   * @stability stable
    * @category mapping
    * @since 4.0.0
    */
@@ -1425,6 +1467,7 @@ export const mapOmit: {
    *
    * @see {@link map} – apply a lambda to all keys
    * @see {@link mapPick} – apply a lambda only to selected keys
+   * @stability stable
    * @category mapping
    * @since 4.0.0
    */
@@ -1501,6 +1544,7 @@ function buildStruct<
  * ```
  *
  * @see {@link makeReducer} – like `makeCombiner` but with an initial value
+ * @stability stable
  * @category combining
  * @since 4.0.0
  */
@@ -1558,6 +1602,7 @@ export function makeCombiner<A>(
  * ```
  *
  * @see {@link makeCombiner} – like `makeReducer` but without an initial value
+ * @stability stable
  * @category folding
  * @since 4.0.0
  */
@@ -1592,6 +1637,7 @@ export function makeReducer<A>(
  * Struct.Record(["a", "b"], "value") // => { a: "value", b: "value" }
  * ```
  *
+ * @stability stable
  * @category constructors
  * @since 4.0.0
  */