effect 4.0.0-beta.69 → 4.0.0-beta.70

package/src/unstable/sql/SqlResolver.ts

@@ -114,12 +114,14 @@ export const SqlRequest = <In, A, E, R>(payload: In): SqlRequest<In, A, E, R> =>
 }
 
 /**
- * Create a resolver for a sql query with a request schema and a result schema.
+ * Creates a resolver for a SQL query with a request schema and a result schema.
  *
- * The request schema is used to validate the input of the query.
- * The result schema is used to validate the output of the query.
+ * **Details**
  *
- * Results are mapped to the requests in order, so the length of the results must match the length of the requests.
+ * The request schema is used to validate the input of the query, and the result
+ * schema is used to validate the output of the query. Results are mapped to the
+ * requests in order, so the length of the results must match the length of the
+ * requests.
  *
  * @category resolvers
  * @since 4.0.0

package/src/unstable/sql/Statement.ts

@@ -471,9 +471,11 @@ export interface Constructor {
   ) => RecordUpdateHelperSingle
 
   /**
-   * Update multiple rows
+   * Update multiple rows.
    *
-   * **Note:** Not supported in sqlite
+   * **Gotchas**
+   *
+   * Not supported in sqlite.
    */
   readonly updateValues: (
     value: ReadonlyArray<Record<string, unknown>>,
@@ -491,9 +493,11 @@ export interface Constructor {
   readonly or: (clauses: ReadonlyArray<string | Fragment>) => Fragment
 
   /**
-   * Create comma seperated values, with an optional prefix
+   * Create comma seperated values, with an optional prefix.
+   *
+   * **When to use**
    *
-   * Useful for `ORDER BY` and `GROUP BY` clauses
+   * Useful for `ORDER BY` and `GROUP BY` clauses.
    */
   readonly csv: {
     (values: ReadonlyArray<string | Fragment>): Fragment

package/src/unstable/workflow/DurableClock.ts

@@ -82,7 +82,7 @@ export const sleep: (
      * If the duration is less than or equal to this threshold, the clock will
      * be executed in memory.
      *
-     * Defaults to 60 seconds.
+     * @default 60 seconds
      */
     readonly inMemoryThreshold?: Duration.Input | undefined
   }

package/src/unstable/workflow/DurableDeferred.ts

@@ -168,6 +168,9 @@ const await_: <Success extends Schema.Top, Error extends Schema.Top>(
 
 export {
   /**
+   * Awaits the durable deferred, suspending the current workflow when no
+   * persisted completion is available.
+   *
    * @category combinators
    * @since 4.0.0
    */

package/src/unstable/workflow/Workflow.ts

@@ -157,12 +157,15 @@ export interface Workflow<
   ) => Effect.Effect<string>
 
   /**
-   * Add compensation logic to an effect inside a Workflow. The compensation finalizer will be
-   * called if the entire workflow fails, allowing you to perform cleanup or
-   * other actions based on the success value and the cause of the workflow failure.
+   * Add compensation logic to an effect inside a Workflow.
    *
-   * NOTE: Compensation will not work for nested activities. Compensation
-   * finalizers are only registered for top-level effects in the workflow.
+   * **Details**
+   *
+   * The compensation finalizer is called if the entire workflow fails, allowing you to perform cleanup or other actions based on the success value and the cause of the workflow failure.
+   *
+   * **Gotchas**
+   *
+   * Compensation finalizers are only registered for top-level effects in the workflow and do not work for nested activities.
    */
   readonly withCompensation: {
     <A, R2>(
@@ -743,10 +746,7 @@ const waitForZero = Effect.fnUntraced(function*(instance: WorkflowInstance["Serv
 })
 
 /**
- * Accesses the workflow scope.
- *
- * The workflow scope is only closed when the workflow execution fully
- * completes.
+ * Accesses the workflow scope, which is only closed when the workflow execution fully completes.
  *
  * @category Scope
  * @since 4.0.0
@@ -761,10 +761,7 @@ export const scope: Effect.Effect<
 )
 
 /**
- * Provides the workflow scope to the given effect.
- *
- * The workflow scope is only closed when the workflow execution fully
- * completes.
+ * Provides the workflow scope to the given effect, and closes the scope only when the workflow execution fully completes.
  *
  * @category Scope
  * @since 4.0.0
@@ -796,24 +793,30 @@ export const addFinalizer: <R>(
 })
 
 /**
- * Add compensation logic to an effect inside a Workflow. The compensation finalizer will be
- * called if the entire workflow fails, allowing you to perform cleanup or
- * other actions based on the success value and the cause of the workflow failure.
+ * Add compensation logic to an effect inside a Workflow.
+ *
+ * **Details**
+ *
+ * The compensation finalizer is called if the entire workflow fails, allowing you to perform cleanup or other actions based on the success value and the cause of the workflow failure.
+ *
+ * **Gotchas**
  *
- * NOTE: Compensation will not work for nested activities. Compensation
- * finalizers are only registered for top-level effects in the workflow.
+ * Compensation finalizers are only registered for top-level effects in the workflow and do not work for nested activities.
  *
  * @category Compensation
  * @since 4.0.0
  */
 export const withCompensation: {
   /**
-   * Add compensation logic to an effect inside a Workflow. The compensation finalizer will be
-   * called if the entire workflow fails, allowing you to perform cleanup or
-   * other actions based on the success value and the cause of the workflow failure.
+   * Add compensation logic to an effect inside a Workflow.
    *
-   * NOTE: Compensation will not work for nested activities. Compensation
-   * finalizers are only registered for top-level effects in the workflow.
+   * **Details**
+   *
+   * The compensation finalizer is called if the entire workflow fails, allowing you to perform cleanup or other actions based on the success value and the cause of the workflow failure.
+   *
+   * **Gotchas**
+   *
+   * Compensation finalizers are only registered for top-level effects in the workflow and do not work for nested activities.
    *
    * @category Compensation
    * @since 4.0.0
@@ -824,12 +827,15 @@ export const withCompensation: {
     effect: Effect.Effect<A, E, R>
   ) => Effect.Effect<A, E, R | R2 | WorkflowInstance | Scope.Scope>
   /**
-   * Add compensation logic to an effect inside a Workflow. The compensation finalizer will be
-   * called if the entire workflow fails, allowing you to perform cleanup or
-   * other actions based on the success value and the cause of the workflow failure.
+   * Add compensation logic to an effect inside a Workflow.
+   *
+   * **Details**
    *
-   * NOTE: Compensation will not work for nested activities. Compensation
-   * finalizers are only registered for top-level effects in the workflow.
+   * The compensation finalizer is called if the entire workflow fails, allowing you to perform cleanup or other actions based on the success value and the cause of the workflow failure.
+   *
+   * **Gotchas**
+   *
+   * Compensation finalizers are only registered for top-level effects in the workflow and do not work for nested activities.
    *
    * @category Compensation
    * @since 4.0.0
@@ -864,10 +870,11 @@ export const suspend = (instance: WorkflowInstance["Service"]): Effect.Effect<ne
   }))
 
 /**
- * If you set this annotation to `true` for a workflow, it will capture defects
- * and include them in the result of the workflow or it's activities.
+ * Captures defects for a workflow and includes them in the result of the workflow or its activities.
  *
- * By default, this is set to `true`, meaning that defects will be captured.
+ * **Details**
+ *
+ * By default, this annotation is set to `true`, meaning defects are captured.
  *
  * @category annotations
  * @since 4.0.0
@@ -880,10 +887,11 @@ export const CaptureDefects = Context.Reference<boolean>(
 )
 
 /**
- * Annotation that causes a workflow to suspend when it encounters any error.
+ * Causes a workflow to suspend when it encounters any error.
+ *
+ * **Details**
  *
- * The suspended execution can later be resumed with the workflow's `resume`
- * method, for example `MyWorkflow.resume(executionId)`.
+ * The suspended execution can later be resumed with the workflow's `resume` method, for example `MyWorkflow.resume(executionId)`.
  *
  * @category annotations
  * @since 4.0.0