@effected/github 0.14.0 → 0.15.0

package/WorkflowDispatch.js

@@ -12,11 +12,13 @@ import { Clock, Context, Duration, Effect, Layer, Option, Schedule, Schema } fro
 * @public
 */
 var WorkflowRunStatus = class extends Schema.Class("WorkflowRunStatus")({
+	/** The run's numeric id. */
 	id: Schema.Int,
 	/** `queued`, `in_progress`, `completed`, … */
 	status: Schema.String,
 	/** Set once `status` is `completed`. */
 	conclusion: Schema.optionalKey(Schema.String),
+	/** The run's web URL. */
 	url: Schema.String
 }) {
 	/** Has the run finished, whatever the outcome? */
@@ -27,11 +29,33 @@ var WorkflowRunStatus = class extends Schema.Class("WorkflowRunStatus")({
 const DEFAULT_INTERVAL = Duration.seconds(10);
 const DEFAULT_TIMEOUT = Duration.minutes(5);
 /**
-* Workflow dispatch.
+* Dispatch workflows, wait for the run they start, and list the repository's
+* workflows.
+*
+* @remarks
+* Provide it with {@link WorkflowDispatch.layer}, which needs a `GitHubClient`;
+* each method also needs a `Repo` in `R`. `list` is an `Effect` value, not a
+* function.
+*
+* @example
+* ```ts
+* import { WorkflowDispatch } from "@effected/github";
+* import { Duration, Effect } from "effect";
+*
+* const release = Effect.gen(function* () {
+*   const workflows = yield* WorkflowDispatch;
+*   const run = yield* workflows.dispatchAndWait("release.yml", "main", {
+*     inputs: { dryRun: "false" },
+*     poll: { interval: Duration.seconds(15), timeout: Duration.minutes(20) },
+*   });
+*   return run.conclusion;
+* });
+* ```
 *
 * @public
 */
 var WorkflowDispatch = class WorkflowDispatch extends Context.Service()("@effected/github/WorkflowDispatch") {
+	/** The live service, built over a `GitHubClient`. */
 	static layer = Layer.effect(this, Effect.map(GitHubClient, (client) => make(client)));
 	/** An in-memory double; unstubbed members die naming themselves. */
 	static makeTest = (overrides = {}) => ({