wip

Author: tim-smart

.changeset/public-books-unite.md

@@ -2,36 +2,34 @@
 "effect": minor
 ---
 
-add RetryPlan module
+add ExecutionPlan module
 
-A `RetryPlan` can be used with `Effect.retry` or `Stream.retry`, allowing you to provide different resources for each step of the plan.
+- A `ExecutionPlan` can be used with `Effect.withExecutionPlan` or `Stream.withExecutionPlan`, allowing you to provide different resources for each step of execution until the effect succeeds or the plan is exhausted.
 
 ```ts
-import type { AiLanguageModel } from "@effect/ai"
+import { type AiLanguageModel } from "@effect/ai"
 import type { Layer } from "effect"
-import { Effect, RetryPlan, Schedule } from "effect"
-
-// usage
+import { Effect, ExecutionPlan, Schedule } from "effect"
 
 declare const layerBad: Layer.Layer<AiLanguageModel.AiLanguageModel>
 declare const layerGood: Layer.Layer<AiLanguageModel.AiLanguageModel>
 
-const ThePlan = RetryPlan.make({
+const ThePlan = ExecutionPlan.make({
   // First try with the bad layer 2 times with a 3 second delay between attempts
   provide: layerBad,
   attempts: 2,
   schedule: Schedule.spaced(3000)
 }).pipe(
   // Then try with the bad layer 3 times with a 1 second delay between attempts
-  RetryPlan.orElse({
+  ExecutionPlan.orElse({
     provide: layerBad,
     attempts: 3,
     schedule: Schedule.spaced(1000)
   }),
   // Finally try with the good layer.
   //
   // If `attempts` is omitted, the plan will only attempt once, unless a schedule is provided.
-  RetryPlan.orElse({
+  ExecutionPlan.orElse({
     provide: layerGood
   })
 )
@@ -41,5 +39,5 @@ declare const effect: Effect.Effect<
   never,
   AiLanguageModel.AiLanguageModel
 >
-const retriedEffect: Effect.Effect<void> = Effect.retry(effect, ThePlan)
+const withPlan: Effect.Effect<void> = Effect.withExecutionPlan(effect, ThePlan)
 ```