effect 3.10.18 → 3.11.0

package/src/Redacted.ts

@@ -63,9 +63,11 @@ export const isRedacted: (u: unknown) => u is Redacted<unknown> = redacted_.isRe
  * securely hiding its content.
  *
  * @example
+ * ```ts
  * import { Redacted } from "effect"
  *
  * const API_KEY = Redacted.make("1234567890")
+ * ```
  *
  * @since 3.3.0
  * @category constructors
@@ -77,11 +79,13 @@ export const make: <A>(value: A) => Redacted<A> = redacted_.make
  * with caution, as it exposes the sensitive data.
  *
  * @example
+ * ```ts
  * import { Redacted } from "effect"
  *
  * const API_KEY = Redacted.make("1234567890")
  *
  * assert.equal(Redacted.value(API_KEY), "1234567890")
+ * ```
  *
  * @since 3.3.0
  * @category getters
@@ -94,6 +98,7 @@ export const value: <A>(self: Redacted<A>) => A = redacted_.value
  * memory longer than necessary.
  *
  * @example
+ * ```ts
  * import { Redacted } from "effect"
  *
  * const API_KEY = Redacted.make("1234567890")
@@ -103,6 +108,7 @@ export const value: <A>(self: Redacted<A>) => A = redacted_.value
  * Redacted.unsafeWipe(API_KEY)
  *
  * assert.throws(() => Redacted.value(API_KEY), new Error("Unable to get redacted value"))
+ * ```
  *
  * @since 3.3.0
  * @category unsafe
@@ -115,6 +121,7 @@ export const unsafeWipe: <A>(self: Redacted<A>) => boolean = redacted_.unsafeWip
  * for comparing `Redacted` instances without exposing their contents.
  *
  * @example
+ * ```ts
  * import { Redacted, Equivalence } from "effect"
  *
  * const API_KEY1 = Redacted.make("1234567890")
@@ -125,6 +132,7 @@ export const unsafeWipe: <A>(self: Redacted<A>) => boolean = redacted_.unsafeWip
  *
  * assert.equal(equivalence(API_KEY1, API_KEY2), false)
  * assert.equal(equivalence(API_KEY1, API_KEY3), true)
+ * ```
  *
  * @category equivalence
  * @since 3.3.0

package/src/RegExp.ts

@@ -11,10 +11,12 @@ import * as predicate from "./Predicate.js"
  * @param input - The value to test.
  *
  * @example
+ * ```ts
  * import { RegExp } from "effect"
  *
  * assert.deepStrictEqual(RegExp.isRegExp(/a/), true)
  * assert.deepStrictEqual(RegExp.isRegExp("a"), false)
+ * ```
  *
  * @category guards
  * @since 3.9.0
@@ -25,9 +27,11 @@ export const isRegExp: (input: unknown) => input is RegExp = predicate.isRegExp
  * Escapes special characters in a regular expression pattern.
  *
  * @example
+ * ```ts
  * import { RegExp } from "effect"
  *
  * assert.deepStrictEqual(RegExp.escape("a*b"), "a\\*b")
+ * ```
  *
  * @since 2.0.0
  */

package/src/Request.ts

@@ -125,6 +125,7 @@ export const tagged: <R extends Request<any, any> & { _tag: string }>(
  * Provides a constructor for a Request Class.
  *
  * @example
+ * ```ts
  * import { Request } from "effect"
  *
  * type Success = string
@@ -133,6 +134,7 @@ export const tagged: <R extends Request<any, any> & { _tag: string }>(
  * class MyRequest extends Request.Class<Success, Error, {
  *   readonly id: string
  * }> {}
+ * ```
  *
  * @since 2.0.0
  * @category constructors
@@ -146,6 +148,7 @@ export const Class: new<Success, Error, A extends Record<string, any>>(
  * Provides a Tagged constructor for a Request Class.
  *
  * @example
+ * ```ts
  * import { Request } from "effect"
  *
  * type Success = string
@@ -154,6 +157,7 @@ export const Class: new<Success, Error, A extends Record<string, any>>(
  * class MyRequest extends Request.TaggedClass("MyRequest")<Success, Error, {
  *   readonly name: string
  * }> {}
+ * ```
  *
  * @since 2.0.0
  * @category constructors

package/src/RequestResolver.ts

@@ -182,6 +182,7 @@ export const around: {
  * @since 2.0.0
  * @category combinators
  * @example
+ * ```ts
  * import { Effect, Request, RequestResolver } from "effect"
  *
  * interface GetUserById extends Request.Request<unknown> {
@@ -197,6 +198,7 @@ export const around: {
  *   (requests) => Effect.log(`got ${requests.length} requests`),
  *   (requests, _) => Effect.log(`finised running ${requests.length} requests`)
  * )
+ * ```
  */
 export const aroundRequests: {
   /**
@@ -208,6 +210,7 @@ export const aroundRequests: {
    * @since 2.0.0
    * @category combinators
    * @example
+   * ```ts
    * import { Effect, Request, RequestResolver } from "effect"
    *
    * interface GetUserById extends Request.Request<unknown> {
@@ -223,6 +226,7 @@ export const aroundRequests: {
    *   (requests) => Effect.log(`got ${requests.length} requests`),
    *   (requests, _) => Effect.log(`finised running ${requests.length} requests`)
    * )
+   * ```
    */
   <A, A2, R2, X, R3>(
     before: (requests: ReadonlyArray<Types.NoInfer<A>>) => Effect.Effect<A2, never, R2>,
@@ -237,6 +241,7 @@ export const aroundRequests: {
    * @since 2.0.0
    * @category combinators
    * @example
+   * ```ts
    * import { Effect, Request, RequestResolver } from "effect"
    *
    * interface GetUserById extends Request.Request<unknown> {
@@ -252,6 +257,7 @@ export const aroundRequests: {
    *   (requests) => Effect.log(`got ${requests.length} requests`),
    *   (requests, _) => Effect.log(`finised running ${requests.length} requests`)
    * )
+   * ```
    */
   <A, R, A2, R2, X, R3>(
     self: RequestResolver<A, R>,

package/src/Runtime.ts

@@ -306,6 +306,7 @@ export const updateContext: {
  * @since 2.0.0
  * @category context
  * @example
+ * ```ts
  * import { Context, Runtime } from "effect"
  *
  * class Name extends Context.Tag("Name")<Name, string>() {}
@@ -313,12 +314,14 @@ export const updateContext: {
  * const runtime: Runtime.Runtime<Name> = Runtime.defaultRuntime.pipe(
  *   Runtime.provideService(Name, "John")
  * )
+ * ```
  */
 export const provideService: {
   /**
    * @since 2.0.0
    * @category context
    * @example
+   * ```ts
    * import { Context, Runtime } from "effect"
    *
    * class Name extends Context.Tag("Name")<Name, string>() {}
@@ -326,12 +329,14 @@ export const provideService: {
    * const runtime: Runtime.Runtime<Name> = Runtime.defaultRuntime.pipe(
    *   Runtime.provideService(Name, "John")
    * )
+   * ```
    */
   <I, S>(tag: Context.Tag<I, S>, service: S): <R>(self: Runtime<R>) => Runtime<I | R>
   /**
    * @since 2.0.0
    * @category context
    * @example
+   * ```ts
    * import { Context, Runtime } from "effect"
    *
    * class Name extends Context.Tag("Name")<Name, string>() {}
@@ -339,6 +344,7 @@ export const provideService: {
    * const runtime: Runtime.Runtime<Name> = Runtime.defaultRuntime.pipe(
    *   Runtime.provideService(Name, "John")
    * )
+   * ```
    */
   <R, I, S>(self: Runtime<R>, tag: Context.Tag<I, S>, service: S): Runtime<R | I>
 } = internal.provideService
@@ -367,6 +373,7 @@ export const updateFiberRefs: {
  * @since 2.0.0
  * @category fiber refs
  * @example
+ * ```ts
  * import { Effect, FiberRef, Runtime } from "effect"
  *
  * const ref = FiberRef.unsafeMake(0)
@@ -377,12 +384,14 @@ export const updateFiberRefs: {
  *
  * // returns 1
  * const result = Runtime.runSync(updatedRuntime)(FiberRef.get(ref))
+ * ```
  */
 export const setFiberRef: {
   /**
    * @since 2.0.0
    * @category fiber refs
    * @example
+   * ```ts
    * import { Effect, FiberRef, Runtime } from "effect"
    *
    * const ref = FiberRef.unsafeMake(0)
@@ -393,12 +402,14 @@ export const setFiberRef: {
    *
    * // returns 1
    * const result = Runtime.runSync(updatedRuntime)(FiberRef.get(ref))
+   * ```
    */
   <A>(fiberRef: FiberRef.FiberRef<A>, value: A): <R>(self: Runtime<R>) => Runtime<R>
   /**
    * @since 2.0.0
    * @category fiber refs
    * @example
+   * ```ts
    * import { Effect, FiberRef, Runtime } from "effect"
    *
    * const ref = FiberRef.unsafeMake(0)
@@ -409,6 +420,7 @@ export const setFiberRef: {
    *
    * // returns 1
    * const result = Runtime.runSync(updatedRuntime)(FiberRef.get(ref))
+   * ```
    */
   <R, A>(self: Runtime<R>, fiberRef: FiberRef.FiberRef<A>, value: A): Runtime<R>
 } = internal.setFiberRef
@@ -417,6 +429,7 @@ export const setFiberRef: {
  * @since 2.0.0
  * @category fiber refs
  * @example
+ * ```ts
  * import { Effect, FiberRef, Runtime } from "effect"
  *
  * const ref = FiberRef.unsafeMake(0)
@@ -428,12 +441,14 @@ export const setFiberRef: {
  *
  * // returns 0
  * const result = Runtime.runSync(updatedRuntime)(FiberRef.get(ref))
+ * ```
  */
 export const deleteFiberRef: {
   /**
    * @since 2.0.0
    * @category fiber refs
    * @example
+   * ```ts
    * import { Effect, FiberRef, Runtime } from "effect"
    *
    * const ref = FiberRef.unsafeMake(0)
@@ -445,12 +460,14 @@ export const deleteFiberRef: {
    *
    * // returns 0
    * const result = Runtime.runSync(updatedRuntime)(FiberRef.get(ref))
+   * ```
    */
   <A>(fiberRef: FiberRef.FiberRef<A>): <R>(self: Runtime<R>) => Runtime<R>
   /**
    * @since 2.0.0
    * @category fiber refs
    * @example
+   * ```ts
    * import { Effect, FiberRef, Runtime } from "effect"
    *
    * const ref = FiberRef.unsafeMake(0)
@@ -462,6 +479,7 @@ export const deleteFiberRef: {
    *
    * // returns 0
    * const result = Runtime.runSync(updatedRuntime)(FiberRef.get(ref))
+   * ```
    */
   <R, A>(self: Runtime<R>, fiberRef: FiberRef.FiberRef<A>): Runtime<R>
 } = internal.deleteFiberRef

package/src/STM.ts

@@ -106,6 +106,8 @@ export interface STMTypeLambda extends TypeLambda {
  */
 declare module "./Context.js" {
   interface Tag<Id, Value> extends STM<Value, never, Id> {}
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+  interface Reference<Id, Value> extends STM<Value> {}
 }
 
 /**