✨ expose Result<T> as public API

lib/result.ts

@@ -1,5 +1,13 @@
 /**
- * @ignore
+ * A value representing either a successful outcome or an error.
+ *
+ * `Result<T>` is used in APIs when you want to preserve both successes and
+ * failures instead of short-circuiting on the first error.
+ *
+ * A successful result has the shape `{ ok: true, value }` and a failed result
+ * has the shape `{ ok: false, error }`.
+ *
+ * @since 4.1
  */
 export type Result<T> = {
   readonly ok: true;
@@ -10,7 +18,18 @@ export type Result<T> = {
 };
 
 /**
- * @ignore
+ * Construct a successful {@link Result}.
+ *
+ * ### Example
+ *
+ * ```javascript
+ * import { Ok } from 'effection';
+ *
+ * let result = Ok("hello");
+ * // { ok: true, value: "hello" }
+ * ```
+ *
+ * @since 4.1
  */
 export function Ok(): Result<void>;
 export function Ok<T>(value: T): Result<T>;
@@ -22,7 +41,18 @@ export function Ok<T>(value?: T): Result<T | undefined> {
 }
 
 /**
- * @ignore
+ * Construct a failed {@link Result}.
+ *
+ * ### Example
+ *
+ * ```javascript
+ * import { Err } from 'effection';
+ *
+ * let result = Err(new Error("oh no"));
+ * // { ok: false, error: Error("oh no") }
+ * ```
+ *
+ * @since 4.1
  */
 export const Err = <T>(error: Error): Result<T> => ({ ok: false, error });