effect 4.0.0-beta.27 → 4.0.0-beta.28

package/src/Exit.ts

@@ -857,10 +857,12 @@ export const map: {
  * **Example** (Mapping over an error)
  *
  * ```ts
- * import { Exit } from "effect"
+ * import { Data, Exit } from "effect"
+ *
+ * class ExitError extends Data.TaggedError("ExitError")<{ readonly input: string }> {}
  *
  * const exit = Exit.fail("bad input")
- * const mapped = Exit.mapError(exit, (e) => new Error(e))
+ * const mapped = Exit.mapError(exit, (e) => new ExitError({ input: e }))
  * console.log(Exit.isFailure(mapped)) // true
  * ```
  *
@@ -884,10 +886,12 @@ export const mapError: {
    * **Example** (Mapping over an error)
    *
    * ```ts
-   * import { Exit } from "effect"
+   * import { Data, Exit } from "effect"
+   *
+   * class ExitError extends Data.TaggedError("ExitError")<{ readonly input: string }> {}
    *
    * const exit = Exit.fail("bad input")
-   * const mapped = Exit.mapError(exit, (e) => new Error(e))
+   * const mapped = Exit.mapError(exit, (e) => new ExitError({ input: e }))
    * console.log(Exit.isFailure(mapped)) // true
    * ```
    *
@@ -911,10 +915,12 @@ export const mapError: {
    * **Example** (Mapping over an error)
    *
    * ```ts
-   * import { Exit } from "effect"
+   * import { Data, Exit } from "effect"
+   *
+   * class ExitError extends Data.TaggedError("ExitError")<{ readonly input: string }> {}
    *
    * const exit = Exit.fail("bad input")
-   * const mapped = Exit.mapError(exit, (e) => new Error(e))
+   * const mapped = Exit.mapError(exit, (e) => new ExitError({ input: e }))
    * console.log(Exit.isFailure(mapped)) // true
    * ```
    *
@@ -941,12 +947,14 @@ export const mapError: {
  * **Example** (Mapping both channels)
  *
  * ```ts
- * import { Exit } from "effect"
+ * import { Data, Exit } from "effect"
+ *
+ * class ExitError extends Data.TaggedError("ExitError")<{ readonly input: string }> {}
  *
  * const exit = Exit.succeed(42)
  * const mapped = Exit.mapBoth(exit, {
  *   onSuccess: (x) => String(x),
- *   onFailure: (e: string) => new Error(e)
+ *   onFailure: (e: string) => new ExitError({ input: e })
  * })
  * console.log(Exit.isSuccess(mapped) && mapped.value) // "42"
  * ```
@@ -972,12 +980,14 @@ export const mapBoth: {
    * **Example** (Mapping both channels)
    *
    * ```ts
-   * import { Exit } from "effect"
+   * import { Data, Exit } from "effect"
+   *
+   * class ExitError extends Data.TaggedError("ExitError")<{ readonly input: string }> {}
    *
    * const exit = Exit.succeed(42)
    * const mapped = Exit.mapBoth(exit, {
    *   onSuccess: (x) => String(x),
-   *   onFailure: (e: string) => new Error(e)
+   *   onFailure: (e: string) => new ExitError({ input: e })
    * })
    * console.log(Exit.isSuccess(mapped) && mapped.value) // "42"
    * ```
@@ -1005,12 +1015,14 @@ export const mapBoth: {
    * **Example** (Mapping both channels)
    *
    * ```ts
-   * import { Exit } from "effect"
+   * import { Data, Exit } from "effect"
+   *
+   * class ExitError extends Data.TaggedError("ExitError")<{ readonly input: string }> {}
    *
    * const exit = Exit.succeed(42)
    * const mapped = Exit.mapBoth(exit, {
    *   onSuccess: (x) => String(x),
-   *   onFailure: (e: string) => new Error(e)
+   *   onFailure: (e: string) => new ExitError({ input: e })
    * })
    * console.log(Exit.isSuccess(mapped) && mapped.value) // "42"
    * ```

package/src/Fiber.ts

@@ -128,6 +128,7 @@ export interface Fiber<out A, out E = never> extends Pipeable {
   readonly minimumLogLevel: LogLevel
   readonly currentStackFrame?: StackFrame | undefined
   readonly maxOpsBeforeYield: number
+  readonly currentPreventYield: boolean
   readonly addObserver: (cb: (exit: Exit<A, E>) => void) => () => void
   readonly interruptUnsafe: (
     fiberId?: number | undefined,

package/src/References.ts

@@ -13,7 +13,7 @@
 import { constTrue, constUndefined } from "./Function.ts"
 import type { LogLevel, Severity } from "./LogLevel.ts"
 import type { ReadonlyRecord } from "./Record.ts"
-import { MaxOpsBeforeYield } from "./Scheduler.ts"
+import { MaxOpsBeforeYield, PreventSchedulerYield } from "./Scheduler.ts"
 import * as ServiceMap from "./ServiceMap.ts"
 import { CurrentTraceLevel, DisablePropagation, MinimumTraceLevel, type SpanLink, Tracer } from "./Tracer.ts"
 
@@ -38,6 +38,11 @@ export {
    * @category references
    */
   MinimumTraceLevel,
+  /**
+   * @since 4.0.0
+   * @category references
+   */
+  PreventSchedulerYield,
   /**
    * @since 4.0.0
    * @category references

package/src/RequestResolver.ts

@@ -181,7 +181,7 @@ const defaultKey = (_request: unknown): unknown => defaultKeyObject
  * )
  *
  * // Use the resolver to handle requests
- * const getUserEffect = Effect.request(GetUserRequest({ id: 123 }), Effect.succeed(UserResolver))
+ * const getUserEffect = Effect.request(GetUserRequest({ id: 123 }), UserResolver)
  * ```
  *
  * @since 2.0.0
@@ -276,7 +276,7 @@ const hashGroupKey = <A, K>(get: (entry: Request.Entry<A>) => K) => {
  * // Usage
  * const getSquareEffect = Effect.request(
  *   GetSquareRequest({ value: 5 }),
- *   Effect.succeed(SquareResolver)
+ *   SquareResolver
  * )
  * // Will resolve to 25
  * ```
@@ -319,7 +319,7 @@ export const fromFunction = <A extends Request.Any>(
  *
  * // Usage with multiple requests
  * const effects = [1, 2, 3].map((value) =>
- *   Effect.request(GetDoubleRequest({ value }), Effect.succeed(DoubleResolver))
+ *   Effect.request(GetDoubleRequest({ value }), DoubleResolver)
  * )
  * const batchedEffect = Effect.all(effects) // [2, 4, 6]
  * ```
@@ -370,7 +370,7 @@ export const fromFunctionBatched = <A extends Request.Any>(
  * // Usage
  * const getUserEffect = Effect.request(
  *   GetUserFromAPIRequest({ id: 123 }),
- *   Effect.succeed(UserAPIResolver)
+ *   UserAPIResolver
  * )
  * ```
  *
@@ -874,7 +874,7 @@ export const never: RequestResolver<never> = make(() => Effect.never)
  * // When more than 5 requests are made, they'll be split into multiple batches
  * const requests = Array.from(
  *   { length: 12 },
- *   (_, i) => Effect.request(GetDataRequest({ id: i }), Effect.succeed(limitedResolver))
+ *   (_, i) => Effect.request(GetDataRequest({ id: i }), limitedResolver)
  * )
  * ```
  *
@@ -910,7 +910,7 @@ export const batchN: {
    * // When more than 5 requests are made, they'll be split into multiple batches
    * const requests = Array.from(
    *   { length: 12 },
-   *   (_, i) => Effect.request(GetDataRequest({ id: i }), Effect.succeed(limitedResolver))
+   *   (_, i) => Effect.request(GetDataRequest({ id: i }), limitedResolver)
    * )
    * ```
    *
@@ -946,7 +946,7 @@ export const batchN: {
    * // When more than 5 requests are made, they'll be split into multiple batches
    * const requests = Array.from(
    *   { length: 12 },
-   *   (_, i) => Effect.request(GetDataRequest({ id: i }), Effect.succeed(limitedResolver))
+   *   (_, i) => Effect.request(GetDataRequest({ id: i }), limitedResolver)
    * )
    * ```
    *
@@ -994,15 +994,15 @@ export const batchN: {
  * const requests = [
  *   Effect.request(
  *     GetUserRequest({ userId: 1, department: "Engineering" }),
- *     Effect.succeed(groupedResolver)
+ *     groupedResolver
  *   ),
  *   Effect.request(
  *     GetUserRequest({ userId: 2, department: "Engineering" }),
- *     Effect.succeed(groupedResolver)
+ *     groupedResolver
  *   ),
  *   Effect.request(
  *     GetUserRequest({ userId: 3, department: "Marketing" }),
- *     Effect.succeed(groupedResolver)
+ *     groupedResolver
  *   )
  * ]
  * ```
@@ -1045,15 +1045,15 @@ export const grouped: {
    * const requests = [
    *   Effect.request(
    *     GetUserRequest({ userId: 1, department: "Engineering" }),
-   *     Effect.succeed(groupedResolver)
+   *     groupedResolver
    *   ),
    *   Effect.request(
    *     GetUserRequest({ userId: 2, department: "Engineering" }),
-   *     Effect.succeed(groupedResolver)
+   *     groupedResolver
    *   ),
    *   Effect.request(
    *     GetUserRequest({ userId: 3, department: "Marketing" }),
-   *     Effect.succeed(groupedResolver)
+   *     groupedResolver
    *   )
    * ]
    * ```
@@ -1096,15 +1096,15 @@ export const grouped: {
    * const requests = [
    *   Effect.request(
    *     GetUserRequest({ userId: 1, department: "Engineering" }),
-   *     Effect.succeed(groupedResolver)
+   *     groupedResolver
    *   ),
    *   Effect.request(
    *     GetUserRequest({ userId: 2, department: "Engineering" }),
-   *     Effect.succeed(groupedResolver)
+   *     groupedResolver
    *   ),
    *   Effect.request(
    *     GetUserRequest({ userId: 3, department: "Marketing" }),
-   *     Effect.succeed(groupedResolver)
+   *     groupedResolver
    *   )
    * ]
    * ```
@@ -1300,7 +1300,7 @@ export const race: {
  * )
  *
  * // Spans will automatically include batch size and request links
- * const effect = Effect.request(GetDataRequest({ id: 123 }), Effect.succeed(tracedResolver))
+ * const effect = Effect.request(GetDataRequest({ id: 123 }), tracedResolver)
  * ```
  *
  * @since 4.0.0
@@ -1342,7 +1342,7 @@ export const withSpan: {
    * )
    *
    * // Spans will automatically include batch size and request links
-   * const effect = Effect.request(GetDataRequest({ id: 123 }), Effect.succeed(tracedResolver))
+   * const effect = Effect.request(GetDataRequest({ id: 123 }), tracedResolver)
    * ```
    *
    * @since 4.0.0
@@ -1387,7 +1387,7 @@ export const withSpan: {
    * )
    *
    * // Spans will automatically include batch size and request links
-   * const effect = Effect.request(GetDataRequest({ id: 123 }), Effect.succeed(tracedResolver))
+   * const effect = Effect.request(GetDataRequest({ id: 123 }), tracedResolver)
    * ```
    *
    * @since 4.0.0
@@ -1509,7 +1509,7 @@ export const asCache: {
     capacity: options.capacity,
     timeToLive: options.timeToLive as any,
     requireServicesAt: options.requireServicesAt ?? "lookup" as ServiceMode,
-    lookup: (req: A) => internal.request(req, Effect.succeed(self))
+    lookup: (req: A) => internal.request(req, self)
   }) as any)
 
 /**