effect 2.0.0-next.56 → 2.0.0-next.57

package/src/MetricKey.ts

@@ -11,6 +11,7 @@ import type * as MetricKeyType from "./MetricKeyType.js"
 import type * as MetricLabel from "./MetricLabel.js"
 import type * as Option from "./Option.js"
 import type { Pipeable } from "./Pipeable.js"
+import type * as Types from "./Types.js"
 
 /**
  * @since 2.0.0
@@ -89,7 +90,7 @@ export declare namespace MetricKey {
    */
   export interface Variance<out Type> {
     readonly [MetricKeyTypeId]: {
-      _Type: (_: never) => Type
+      _Type: Types.Covariant<Type>
     }
   }
 }

package/src/MetricKeyType.ts

@@ -8,6 +8,7 @@ import * as internal from "./internal/metric/keyType.js"
 import type * as MetricBoundaries from "./MetricBoundaries.js"
 import type * as MetricState from "./MetricState.js"
 import type { Pipeable } from "./Pipeable.js"
+import type * as Types from "./Types.js"
 
 /**
  * @since 2.0.0
@@ -151,8 +152,8 @@ export declare namespace MetricKeyType {
    */
   export interface Variance<in In, out Out> {
     readonly [MetricKeyTypeTypeId]: {
-      readonly _In: (_: In) => void
-      readonly _Out: (_: never) => Out
+      readonly _In: Types.Contravariant<In>
+      readonly _Out: Types.Covariant<Out>
     }
   }
 

package/src/MetricPair.ts

@@ -6,6 +6,7 @@ import type * as MetricKey from "./MetricKey.js"
 import type * as MetricKeyType from "./MetricKeyType.js"
 import type * as MetricState from "./MetricState.js"
 import type { Pipeable } from "./Pipeable.js"
+import type * as Types from "./Types.js"
 
 /**
  * @since 2.0.0
@@ -46,7 +47,7 @@ export declare namespace MetricPair {
    */
   export interface Variance<out Type extends MetricKeyType.MetricKeyType<any, any>> {
     readonly [MetricPairTypeId]: {
-      readonly _Type: (_: never) => Type
+      readonly _Type: Types.Covariant<Type>
     }
   }
 }

package/src/MetricState.ts

@@ -8,6 +8,7 @@ import * as internal from "./internal/metric/state.js"
 import type * as MetricKeyType from "./MetricKeyType.js"
 import type * as Option from "./Option.js"
 import type { Pipeable } from "./Pipeable.js"
+import type * as Types from "./Types.js"
 
 /**
  * @since 2.0.0
@@ -163,7 +164,7 @@ export declare namespace MetricState {
    */
   export interface Variance<in A> {
     readonly [MetricStateTypeId]: {
-      readonly _A: (_: A) => void
+      readonly _A: Types.Contravariant<A>
     }
   }
 }

package/src/MutableHashMap.ts

@@ -3,7 +3,7 @@
  */
 import * as Dual from "./Function.js"
 import * as HashMap from "./HashMap.js"
-import { type Inspectable, NodeInspectSymbol, toJSON, toString } from "./Inspectable.js"
+import { format, type Inspectable, NodeInspectSymbol, toJSON } from "./Inspectable.js"
 import * as MutableRef from "./MutableRef.js"
 import * as Option from "./Option.js"
 import type { Pipeable } from "./Pipeable.js"
@@ -34,7 +34,7 @@ const MutableHashMapProto: Omit<MutableHashMap<unknown, unknown>, "backingMap">
     return this.backingMap.current[Symbol.iterator]()
   },
   toString() {
-    return toString(this.toJSON())
+    return format(this.toJSON())
   },
   toJSON() {
     return {

package/src/MutableHashSet.ts

@@ -2,7 +2,7 @@
  * @since 2.0.0
  */
 import * as Dual from "./Function.js"
-import { type Inspectable, NodeInspectSymbol, toJSON, toString } from "./Inspectable.js"
+import { format, type Inspectable, NodeInspectSymbol, toJSON } from "./Inspectable.js"
 import * as MutableHashMap from "./MutableHashMap.js"
 import type { Pipeable } from "./Pipeable.js"
 import { pipeArguments } from "./Pipeable.js"
@@ -32,7 +32,7 @@ const MutableHashSetProto: Omit<MutableHashSet<unknown>, "keyMap"> = {
     return Array.from(this.keyMap).map(([_]) => _)[Symbol.iterator]()
   },
   toString() {
-    return toString(this.toJSON())
+    return format(this.toJSON())
   },
   toJSON() {
     return {

package/src/MutableList.ts

@@ -2,7 +2,7 @@
  * @since 2.0.0
  */
 import * as Dual from "./Function.js"
-import { NodeInspectSymbol, toJSON, toString } from "./Inspectable.js"
+import { format, NodeInspectSymbol, toJSON } from "./Inspectable.js"
 import type { Inspectable } from "./Inspectable.js"
 import type { Pipeable } from "./Pipeable.js"
 import { pipeArguments } from "./Pipeable.js"
@@ -55,7 +55,7 @@ const MutableListProto: Omit<MutableList<unknown>, "head" | "tail"> = {
     }
   },
   toString() {
-    return toString(this.toJSON())
+    return format(this.toJSON())
   },
   toJSON() {
     return {

package/src/MutableQueue.ts

@@ -3,7 +3,7 @@
  */
 import * as Chunk from "./Chunk.js"
 import * as Dual from "./Function.js"
-import { type Inspectable, NodeInspectSymbol, toJSON, toString } from "./Inspectable.js"
+import { format, type Inspectable, NodeInspectSymbol, toJSON } from "./Inspectable.js"
 import * as MutableList from "./MutableList.js"
 import type { Pipeable } from "./Pipeable.js"
 import { pipeArguments } from "./Pipeable.js"
@@ -51,7 +51,7 @@ const MutableQueueProto: Omit<MutableQueue<unknown>, "queue" | "capacity"> = {
     return Array.from(this.queue)[Symbol.iterator]()
   },
   toString() {
-    return toString(this.toJSON())
+    return format(this.toJSON())
   },
   toJSON() {
     return {

package/src/MutableRef.ts

@@ -3,7 +3,7 @@
  */
 import * as Equal from "./Equal.js"
 import * as Dual from "./Function.js"
-import { type Inspectable, NodeInspectSymbol, toJSON, toString } from "./Inspectable.js"
+import { format, type Inspectable, NodeInspectSymbol, toJSON } from "./Inspectable.js"
 import type { Pipeable } from "./Pipeable.js"
 import { pipeArguments } from "./Pipeable.js"
 
@@ -29,7 +29,7 @@ export interface MutableRef<out T> extends Pipeable, Inspectable {
 const MutableRefProto: Omit<MutableRef<unknown>, "current"> = {
   [TypeId]: TypeId,
   toString<A>(this: MutableRef<A>): string {
-    return toString(this.toJSON())
+    return format(this.toJSON())
   },
   toJSON<A>(this: MutableRef<A>) {
     return {

package/src/Option.ts

@@ -6,7 +6,7 @@ import type { Either } from "./Either.js"
 import * as Equal from "./Equal.js"
 import * as Equivalence from "./Equivalence.js"
 import type { LazyArg } from "./Function.js"
-import { constNull, constUndefined, dual, identity } from "./Function.js"
+import { constNull, constUndefined, dual, identity, isFunction } from "./Function.js"
 import type { TypeLambda } from "./HKT.js"
 import type { Inspectable } from "./Inspectable.js"
 import * as either from "./internal/either.js"
@@ -15,6 +15,7 @@ import type { Order } from "./Order.js"
 import * as order from "./Order.js"
 import type { Pipeable } from "./Pipeable.js"
 import type { Predicate, Refinement } from "./Predicate.js"
+import type * as Types from "./Types.js"
 import type * as Unify from "./Unify.js"
 import * as Gen from "./Utils.js"
 
@@ -44,7 +45,7 @@ export interface None<out A> extends Data.Case, Pipeable, Inspectable {
   readonly _tag: "None"
   readonly _op: "None"
   readonly [TypeId]: {
-    readonly _A: (_: never) => A
+    readonly _A: Types.Covariant<A>
   }
   [Unify.typeSymbol]?: unknown
   [Unify.unifySymbol]?: OptionUnify<this>
@@ -60,7 +61,7 @@ export interface Some<out A> extends Data.Case, Pipeable, Inspectable {
   readonly _op: "Some"
   readonly value: A
   readonly [TypeId]: {
-    readonly _A: (_: never) => A
+    readonly _A: Types.Covariant<A>
   }
   [Unify.typeSymbol]?: unknown
   [Unify.unifySymbol]?: OptionUnify<this>
@@ -553,7 +554,7 @@ export const getOrThrow: <A>(self: Option<A>) => A = getOrThrowWith(() => new Er
  * @param self - An `Option` to map
  * @param f - The function to map over the value of the `Option`
  *
- * @category transforming
+ * @category mapping
  * @since 2.0.0
  */
 export const map: {
@@ -567,7 +568,7 @@ export const map: {
 /**
  * Maps the `Some` value of this `Option` to the specified constant value.
  *
- * @category transforming
+ * @category mapping
  * @since 2.0.0
  */
 export const as: {
@@ -579,7 +580,7 @@ export const as: {
  *
  * This is useful when the value of the `Option` is not needed, but the presence or absence of the value is important.
  *
- * @category transforming
+ * @category mapping
  * @since 2.0.0
  */
 export const asUnit: <_>(self: Option<_>) => Option<void> = as(undefined)
@@ -592,7 +593,7 @@ export const unit: Option<void> = some(undefined)
 /**
  * Applies a function to the value of an `Option` and flattens the result, if the input is `Some`.
  *
- * @category transforming
+ * @category sequencing
  * @since 2.0.0
  */
 export const flatMap: {
@@ -603,6 +604,23 @@ export const flatMap: {
   <A, B>(self: Option<A>, f: (a: A) => Option<B>): Option<B> => isNone(self) ? none() : f(self.value)
 )
 
+/**
+ * Executes a sequence of two `Option`s. The second `Option` can be dependent on the result of the first `Option`.
+ *
+ * @category sequencing
+ * @since 2.0.0
+ */
+export const andThen: {
+  <A, B>(f: (a: A) => Option<B>): (self: Option<A>) => Option<B>
+  <B>(f: Option<B>): <A>(self: Option<A>) => Option<B>
+  <A, B>(self: Option<A>, f: (a: A) => Option<B>): Option<B>
+  <A, B>(self: Option<A>, f: Option<B>): Option<B>
+} = dual(
+  2,
+  <A, B>(self: Option<A>, f: (a: A) => Option<B> | Option<B>): Option<B> =>
+    isFunction(f) ? flatMap(self, f) : flatMap(self, () => f)
+)
+
 /**
  * This is `flatMap` + `fromNullable`, useful when working with optional values.
  *
@@ -640,7 +658,7 @@ export const flatMap: {
  *   none()
  * )
  *
- * @category transforming
+ * @category sequencing
  * @since 2.0.0
  */
 export const flatMapNullable: {
@@ -653,13 +671,13 @@ export const flatMapNullable: {
 )
 
 /**
- * @category transforming
+ * @category sequencing
  * @since 2.0.0
  */
 export const flatten: <A>(self: Option<Option<A>>) => Option<A> = flatMap(identity)
 
 /**
- * @category transforming
+ * @category zipping
  * @since 2.0.0
  */
 export const zipRight: {
@@ -668,7 +686,7 @@ export const zipRight: {
 } = dual(2, <_, B>(self: Option<_>, that: Option<B>): Option<B> => flatMap(self, () => that))
 
 /**
- * @category transforming
+ * @category sequencing
  * @since 2.0.0
  */
 export const composeK: {
@@ -684,7 +702,7 @@ export const composeK: {
  * @param that - The `Option` that will be ignored in the chain and discarded
  * @param self - The `Option` we care about
  *
- * @category transforming
+ * @category zipping
  * @since 2.0.0
  */
 export const zipLeft: {
@@ -710,7 +728,7 @@ export const zipLeft: {
  * assert.deepStrictEqual(O.tap(O.some(1), getInteger), O.some(1))
  * assert.deepStrictEqual(O.tap(O.some(1.14), getInteger), O.none())
  *
- * @category transforming
+ * @category sequencing
  * @since 2.0.0
  */
 export const tap: {
@@ -818,7 +836,7 @@ export const all: <const I extends Iterable<Option<any>> | Record<string, Option
  *
  * assert.deepStrictEqual(O.zipWith(O.some(1), complex)(O.some(2)), O.some([2, 1]))
  *
- * @category combining
+ * @category zipping
  * @since 2.0.0
  */
 export const zipWith: {

package/src/Order.ts

@@ -108,7 +108,7 @@ export const empty = <A>(): Order<A> => make(() => 0)
 export const combineAll = <A>(collection: Iterable<Order<A>>): Order<A> => combineMany(empty(), collection)
 
 /**
- * @category combinators
+ * @category mapping
  * @since 2.0.0
  */
 export const mapInput: {

package/src/Pool.ts

@@ -7,6 +7,7 @@ import type * as Effect from "./Effect.js"
 import * as internal from "./internal/pool.js"
 import type { Pipeable } from "./Pipeable.js"
 import type * as Scope from "./Scope.js"
+import type * as Types from "./Types.js"
 
 /**
  * @since 2.0.0
@@ -54,8 +55,8 @@ export declare namespace Pool {
    */
   export interface Variance<out E, in out A> {
     readonly [PoolTypeId]: {
-      readonly _E: (_: never) => E
-      readonly _A: (_: A) => A
+      readonly _E: Types.Covariant<E>
+      readonly _A: Types.Invariant<A>
     }
   }
 }
@@ -93,24 +94,22 @@ export const make: <R, E, A>(
  * unspecified order.
  *
  * ```ts
- * import * as Duration from "./Duration"
- * import * as Effect from "effect/Effect"
- * import * as Pool from "effect/Pool"
- * import * as Scope from "effect/Scope"
- * import { pipe } from "./Function"
+ * import { createConnection } from "mysql2";
+ * import { Duration, Effect, Pool } from "effect"
  *
- * Effect.scoped(
- *   pipe(
- *     Pool.make(acquireDbConnection, 10, 20, Duration.seconds(60)),
- *     Effect.flatMap((pool) =>
- *       Effect.scoped(
- *         pipe(
- *           pool.get(),
- *           Effect.flatMap((connection) => useConnection(connection))
- *         )
- *       )
- *     )
- *   )
+ * const acquireDBConnection = Effect.acquireRelease(
+ *   Effect.sync(() => createConnection('mysql://...')),
+ *   (connection) => Effect.sync(() => connection.end(() => {})),
+ * )
+ *
+ * const connectionPool = Effect.flatMap(
+ *  Pool.makeWithTTL({
+ *     acquire: acquireDBConnection,
+ *     min: 10,
+ *     max: 20,
+ *     timeToLive: Duration.seconds(60)
+ *   }),
+ *   (pool) => pool.get
  * )
  * ```
  *

package/src/PrimaryKey.ts

@@ -15,3 +15,9 @@ export const symbol: unique symbol = Symbol.for("effect/PrimaryKey")
 export interface PrimaryKey {
   [symbol](): string
 }
+
+/**
+ * @since 2.0.0
+ * @category accessors
+ */
+export const value = (self: PrimaryKey): string => self[symbol]()

package/src/Queue.ts

@@ -9,6 +9,7 @@ import type * as MutableQueue from "./MutableQueue.js"
 import type * as MutableRef from "./MutableRef.js"
 import type * as Option from "./Option.js"
 import type { Pipeable } from "./Pipeable.js"
+import type * as Types from "./Types.js"
 
 /**
  * @since 2.0.0
@@ -295,7 +296,7 @@ export declare namespace Queue {
    */
   export interface EnqueueVariance<in A> {
     readonly [EnqueueTypeId]: {
-      readonly _In: (_: A) => void
+      readonly _In: Types.Contravariant<A>
     }
   }
 
@@ -305,7 +306,7 @@ export declare namespace Queue {
    */
   export interface DequeueVariance<out A> {
     readonly [DequeueTypeId]: {
-      readonly _Out: (_: never) => A
+      readonly _Out: Types.Covariant<A>
     }
   }
 
@@ -315,7 +316,7 @@ export declare namespace Queue {
    */
   export interface StrategyVariance<in out A> {
     readonly [QueueStrategyTypeId]: {
-      readonly _A: (_: A) => A
+      readonly _A: Types.Invariant<A>
     }
   }
 
@@ -325,7 +326,7 @@ export declare namespace Queue {
    */
   export interface BackingQueueVariance<in out A> {
     readonly [BackingQueueTypeId]: {
-      readonly _A: (_: A) => A
+      readonly _A: Types.Invariant<A>
     }
   }
 }