docs: add module js doc

Author: totto2727

deno.json

@@ -22,16 +22,17 @@
     "./effect/typeclass": "./effect/typeclass.ts",
     "./option-t": "./option-t.ts",
     "./option-t/effect": "./option-t/effect.ts",
-    "./option-t/safe-try": "./option-t/safe-try.ts"
+    "./option-t/safe-try": "./option-t/safe-try.ts",
+    "./test": "./test.ts"
   },
   "license": "MIT",
   "lock": false,
   "name": "@totto/function",
   "tasks": {
     "build": "deno publish --dry-run --allow-dirty",
     "fix": "deno check **/*.ts && deno fmt && deno lint",
-    "test": "deno test **/*.test.ts",
-    "precommit": "deno task fix && deno task build && deno task test"
+    "precommit": "deno task fix && deno task build && deno task test",
+    "test": "deno test **/*.test.ts"
   },
-  "version": "0.1.0"
+  "version": "0.1.1"
 }

effect.ts

@@ -1 +1,12 @@
+/**
+ * @module
+ *
+ * Re-exports of `effect` modules.
+ *
+ * @example
+ * ```ts
+ * import { Effect } from "@totto/function/effect";
+ * ```
+ */
+
 export * from "npm:[email protected]";

effect/ai.ts

@@ -1 +1,12 @@
+/**
+ * @module
+ *
+ * Re-exports of `@effect/ai` modules.
+ *
+ * @example
+ * ```ts
+ * import { Ai } from "@totto/function/effect/ai";
+ * ```
+ */
+
 export * from "npm:@effect/[email protected]";

effect/ai/anthropic.ts

@@ -1 +1,12 @@
+/**
+ * @module
+ *
+ * Re-exports of `@effect/ai-anthropic` modules.
+ *
+ * @example
+ * ```ts
+ * import { Anthropic } from "@totto/function/effect/ai/anthropic";
+ * ```
+ */
+
 export * from "npm:@effect/[email protected]";

effect/ai/openai.ts

@@ -1 +1,12 @@
+/**
+ * @module
+ *
+ * Re-exports of `@effect/ai-openai` modules.
+ *
+ * @example
+ * ```ts
+ * import { Openai } from "@totto/function/effect/ai/openai";
+ * ```
+ */
+
 export * from "npm:@effect/[email protected]";

effect/cli.ts

@@ -1 +1,12 @@
+/**
+ * @module
+ *
+ * Re-exports of `@effect/cli` modules.
+ *
+ * @example
+ * ```ts
+ * import { Cli } from "@totto/function/effect/cli";
+ * ```
+ */
+
 export * from "npm:@effect/[email protected]";

effect/experimental/deps.ts

@@ -1 +1,7 @@
+/**
+ * @module
+ *
+ * Re-exports of Effect's experimental modules.
+ */
+
 export * from "npm:@effect/[email protected]";

effect/experimental/machine.ts

@@ -1 +1,12 @@
+/**
+ * @module
+ *
+ * Re-exports of Effect's experimental `Machine` module.
+ *
+ * @example
+ * ```ts
+ * import { Machine } from "@totto/function/effect/experimental/machine";
+ * ```
+ */
+
 export { Machine } from "./deps.ts";

effect/opentelemetry.ts

@@ -1 +1,12 @@
+/**
+ * @module
+ *
+ * Re-exports of `@effect/opentelemetry` modules.
+ *
+ * @example
+ * ```ts
+ * import { Opentelemetry } from "@totto/function/effect/opentelemetry";
+ * ```
+ */
+
 export * from "npm:@effect/[email protected]";

effect/option-t.ts

@@ -1,6 +1,22 @@
+/**
+ * @module
+ *
+ * Converts Option-t's `Result` to Effect's `Exit`.
+ *
+ * @example
+ * ```ts
+ * import { fromResult } from "@totto/function/effect/option-t";
+ *
+ * const exit = fromResult(Result.createOk("success"));
+ * // exit: Exit.Success("success")
+ * ```
+ */
 import { Result } from "../option-t.ts";
 import { Exit } from "../effect.ts";
 
+/**
+ * Converts an Option-t's `Result` object into an Effect's `Exit` object.
+ */
 export function fromResult<OK, ERR>(
   result: Result.Result<OK, ERR>,
 ): Exit.Exit<OK, ERR> {

effect/platform.ts

@@ -1 +1,12 @@
+/**
+ * @module
+ *
+ * Re-exports of `@effect/platform` modules.
+ *
+ * @example
+ * ```ts
+ * import { Platform } from "@totto/function/effect/platform";
+ * ```
+ */
+
 export * from "npm:@effect/[email protected]";

effect/platform/browser.ts

@@ -1 +1,12 @@
+/**
+ * @module
+ *
+ * Re-exports of `@effect/platform-browser` modules.
+ *
+ * @example
+ * ```ts
+ * import { PlatformBrowser } from "@totto/function/effect/platform/browser";
+ * ```
+ */
+
 export * from "npm:@effect/[email protected]";

effect/platform/bun.ts

@@ -1 +1,12 @@
+/**
+ * @module
+ *
+ * Re-exports of `@effect/platform-bun` modules.
+ *
+ * @example
+ * ```ts
+ * import { PlatformBun } from "@totto/function/effect/platform/bun";
+ * ```
+ */
+
 export * from "npm:@effect/[email protected]";

effect/platform/node-share.ts

@@ -1 +1,12 @@
+/**
+ * @module
+ *
+ * Re-exports of `@effect/platform-node-shared` modules.
+ *
+ * @example
+ * ```ts
+ * import { PlatformNodeShared } from "@totto/function/effect/platform/node-share";
+ * ```
+ */
+
 export * from "npm:@effect/[email protected]";

effect/platform/node.ts

@@ -1 +1,12 @@
+/**
+ * @module
+ *
+ * Re-exports of `@effect/platform-node` modules.
+ *
+ * @example
+ * ```ts
+ * import { PlatformNode } from "@totto/function/effect/platform/node";
+ * ```
+ */
+
 export * from "npm:@effect/[email protected]";

effect/printer.ts

@@ -1 +1,12 @@
+/**
+ * @module
+ *
+ * Re-exports of `@effect/printer` modules.
+ *
+ * @example
+ * ```ts
+ * import { Printer } from "@totto/function/effect/printer";
+ * ```
+ */
+
 export * from "npm:@effect/[email protected]";

effect/printer/ansi.ts

@@ -1 +1,12 @@
+/**
+ * @module
+ *
+ * Re-exports of `@effect/printer-ansi` modules.
+ *
+ * @example
+ * ```ts
+ * import { PrinterAnsi } from "@totto/function/effect/printer/ansi";
+ * ```
+ */
+
 export * from "npm:@effect/[email protected]";

effect/rpc.ts

@@ -1 +1,12 @@
+/**
+ * @module
+ *
+ * Re-exports of `@effect/rpc` modules.
+ *
+ * @example
+ * ```ts
+ * import { Rpc } from "@totto/function/effect/rpc";
+ * ```
+ */
+
 export * from "npm:@effect/[email protected]";

effect/rpc/http.ts

@@ -1 +1,12 @@
+/**
+ * @module
+ *
+ * Re-exports of `@effect/rpc-http` modules.
+ *
+ * @example
+ * ```ts
+ * import { RpcHttp } from "@totto/function/effect/rpc/http";
+ * ```
+ */
+
 export * from "npm:@effect/[email protected]";