add Request.failCause

.changeset/plenty-radios-crash.md

@@ -0,0 +1,5 @@
+---
+"effect": patch
+---
+
+add Request.failCause

docs/modules/Request.ts.md

@@ -34,6 +34,7 @@ Added in v2.0.0
   - [complete](#complete)
   - [completeEffect](#completeeffect)
   - [fail](#fail)
+  - [failCause](#failcause)
   - [interruptWhenPossible](#interruptwhenpossible)
   - [succeed](#succeed)
 - [symbols](#symbols)
@@ -352,6 +353,21 @@ export declare const fail: {
 
 Added in v2.0.0
 
+## failCause
+
+Complete a `Request` with the specified cause.
+
+**Signature**
+
+```ts
+export declare const failCause: {
+  <A extends Request<any, any>>(cause: Cause<Request.Error<A>>): (self: A) => Effect.Effect<never, never, void>
+  <A extends Request<any, any>>(self: A, cause: Cause<Request.Error<A>>): Effect.Effect<never, never, void>
+}
+```
+
+Added in v2.0.0
+
 ## interruptWhenPossible
 
 Interrupts the child effect when requests are no longer needed

src/Request.ts

@@ -2,6 +2,7 @@
  * @since 2.0.0
  */
 import type * as _Cache from "./Cache.js"
+import type { Cause } from "./Cause.js"
 import type * as Data from "./Data.js"
 import type { Deferred } from "./Deferred.js"
 import type { DurationInput } from "./Duration.js"
@@ -216,6 +217,17 @@ export const fail: {
   <A extends Request<any, any>>(self: A, error: Request.Error<A>): Effect.Effect<never, never, void>
 } = internal.fail
 
+/**
+ * Complete a `Request` with the specified cause.
+ *
+ * @since 2.0.0
+ * @category request completion
+ */
+export const failCause: {
+  <A extends Request<any, any>>(cause: Cause<Request.Error<A>>): (self: A) => Effect.Effect<never, never, void>
+  <A extends Request<any, any>>(self: A, cause: Cause<Request.Error<A>>): Effect.Effect<never, never, void>
+} = internal.failCause
+
 /**
  * Complete a `Request` with the specified value.
  *

src/internal/request.ts

@@ -1,3 +1,4 @@
+import type * as Cause from "../Cause.js"
 import type * as Effect from "../Effect.js"
 import { dual } from "../Function.js"
 import { hasProperty } from "../Predicate.js"
@@ -120,6 +121,17 @@ export const fail = dual<
   ) => Effect.Effect<never, never, void>
 >(2, (self, error) => complete(self, core.exitFail(error) as any))
 
+/** @internal */
+export const failCause = dual<
+  <A extends Request.Request<any, any>>(
+    cause: Cause.Cause<Request.Request.Error<A>>
+  ) => (self: A) => Effect.Effect<never, never, void>,
+  <A extends Request.Request<any, any>>(
+    self: A,
+    cause: Cause.Cause<Request.Request.Error<A>>
+  ) => Effect.Effect<never, never, void>
+>(2, (self, cause) => complete(self, core.exitFailCause(cause) as any))
+
 /** @internal */
 export const succeed = dual<
   <A extends Request.Request<any, any>>(