Merge pull request #955 from thefrontside/v4-constant-docs

📝 document the `constant()` function
thefrontside · Jan 6, 2025 · cdf515c · cdf515c
2 parents e32a658 + 035179d
commit cdf515c
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/lib/constant.ts b/lib/constant.ts
@@ -1,5 +1,17 @@
 import type { Operation } from "./types.ts";
 
+/**
+ * Create an {@link Operation} that always evaluates to `value`.
+ *
+ * @example
+ *
+ * ```ts
+ * let x = yield* constant("hello world");
+ * x === "hello world" //=> true
+ * ```
+ *
+ * @returns the {@link Operation} that evaluates to `value`;
+ */
 export function constant<T>(value: T): Operation<T> {
   return {
     [Symbol.iterator]: () => ({ next: () => ({ done: true, value }) }),