Skip to content

Commit 6d47033

Browse files
committed
fix: move module doc comment
1 parent 88bcbf3 commit 6d47033

26 files changed

+51
-49
lines changed

.github/workflows/publish.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ jobs:
1717

1818
- uses: denoland/setup-deno@v2
1919
with:
20-
deno-version: v2.x
20+
deno-version: v2.x
2121

2222
- name: Publish package
2323
run: deno publish

deno.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -34,5 +34,5 @@
3434
"precommit": "deno task fix && deno task build && deno task test",
3535
"test": "deno test **/*.test.ts"
3636
},
37-
"version": "0.1.2"
37+
"version": "0.1.3"
3838
}

effect.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
/**
2-
* @module
3-
*
42
* Re-exports of `effect` modules.
53
*
64
* @example
75
* ```ts
86
* import { Effect } from "@totto/function/effect";
97
* ```
8+
9+
* @module
1010
*/
1111

1212
export * from "npm:[email protected]";

effect/ai.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
/**
2-
* @module
3-
*
42
* Re-exports of `@effect/ai` modules.
53
*
64
* @example
75
* ```ts
86
* import { Ai } from "@totto/function/effect/ai";
97
* ```
8+
*
9+
* @module
1010
*/
1111

1212
export * from "npm:@effect/[email protected]";

effect/ai/anthropic.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
/**
2-
* @module
3-
*
42
* Re-exports of `@effect/ai-anthropic` modules.
53
*
64
* @example
75
* ```ts
86
* import { Anthropic } from "@totto/function/effect/ai/anthropic";
97
* ```
8+
*
9+
* @module
1010
*/
1111

1212
export * from "npm:@effect/[email protected]";

effect/ai/openai.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
/**
2-
* @module
3-
*
42
* Re-exports of `@effect/ai-openai` modules.
53
*
64
* @example
75
* ```ts
86
* import { Openai } from "@totto/function/effect/ai/openai";
97
* ```
8+
*
9+
* @module
1010
*/
1111

1212
export * from "npm:@effect/[email protected]";

effect/cli.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
/**
2-
* @module
3-
*
42
* Re-exports of `@effect/cli` modules.
53
*
64
* @example
75
* ```ts
86
* import { Cli } from "@totto/function/effect/cli";
97
* ```
8+
*
9+
* @module
1010
*/
1111

1212
export * from "npm:@effect/[email protected]";

effect/experimental/deps.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/**
2-
* @module
3-
*
42
* Re-exports of Effect's experimental modules.
3+
*
4+
* @module
55
*/
66

77
export * from "npm:@effect/[email protected]";

effect/experimental/machine.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
/**
2-
* @module
3-
*
42
* Re-exports of Effect's experimental `Machine` module.
53
*
64
* @example
75
* ```ts
86
* import { Machine } from "@totto/function/effect/experimental/machine";
97
* ```
8+
*
9+
* @module
1010
*/
1111

1212
export { Machine } from "./deps.ts";

effect/opentelemetry.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
/**
2-
* @module
3-
*
42
* Re-exports of `@effect/opentelemetry` modules.
53
*
64
* @example
75
* ```ts
86
* import { Opentelemetry } from "@totto/function/effect/opentelemetry";
97
* ```
8+
*
9+
* @module
1010
*/
1111

1212
export * from "npm:@effect/[email protected]";

effect/option-t.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,4 @@
11
/**
2-
* @module
3-
*
42
* Converts Option-t's `Result` to Effect's `Exit`.
53
*
64
* @example
@@ -10,6 +8,8 @@
108
* const exit = fromResult(Result.createOk("success"));
119
* // exit: Exit.Success("success")
1210
* ```
11+
*
12+
* @module
1313
*/
1414
import { Result } from "../option-t.ts";
1515
import { Exit } from "../effect.ts";

effect/platform.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
/**
2-
* @module
3-
*
42
* Re-exports of `@effect/platform` modules.
53
*
64
* @example
75
* ```ts
86
* import { Platform } from "@totto/function/effect/platform";
97
* ```
8+
*
9+
* @module
1010
*/
1111

1212
export * from "npm:@effect/[email protected]";

effect/platform/browser.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
/**
2-
* @module
3-
*
42
* Re-exports of `@effect/platform-browser` modules.
53
*
64
* @example
75
* ```ts
86
* import { PlatformBrowser } from "@totto/function/effect/platform/browser";
97
* ```
8+
*
9+
* @module
1010
*/
1111

1212
export * from "npm:@effect/[email protected]";

effect/platform/bun.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
/**
2-
* @module
3-
*
42
* Re-exports of `@effect/platform-bun` modules.
53
*
64
* @example
75
* ```ts
86
* import { PlatformBun } from "@totto/function/effect/platform/bun";
97
* ```
8+
*
9+
* @module
1010
*/
1111

1212
export * from "npm:@effect/[email protected]";

effect/platform/node-share.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
/**
2-
* @module
3-
*
42
* Re-exports of `@effect/platform-node-shared` modules.
53
*
64
* @example
75
* ```ts
86
* import { PlatformNodeShared } from "@totto/function/effect/platform/node-share";
97
* ```
8+
*
9+
* @module
1010
*/
1111

1212
export * from "npm:@effect/[email protected]";

effect/platform/node.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
/**
2-
* @module
3-
*
42
* Re-exports of `@effect/platform-node` modules.
53
*
64
* @example
75
* ```ts
86
* import { PlatformNode } from "@totto/function/effect/platform/node";
97
* ```
8+
*
9+
* @module
1010
*/
1111

1212
export * from "npm:@effect/[email protected]";

effect/printer.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
/**
2-
* @module
3-
*
42
* Re-exports of `@effect/printer` modules.
53
*
64
* @example
75
* ```ts
86
* import { Printer } from "@totto/function/effect/printer";
97
* ```
8+
*
9+
* @module
1010
*/
1111

1212
export * from "npm:@effect/[email protected]";

effect/printer/ansi.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
/**
2-
* @module
3-
*
42
* Re-exports of `@effect/printer-ansi` modules.
53
*
64
* @example
75
* ```ts
86
* import { PrinterAnsi } from "@totto/function/effect/printer/ansi";
97
* ```
8+
*
9+
* @module
1010
*/
1111

1212
export * from "npm:@effect/[email protected]";

effect/rpc.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
/**
2-
* @module
3-
*
42
* Re-exports of `@effect/rpc` modules.
53
*
64
* @example
75
* ```ts
86
* import { Rpc } from "@totto/function/effect/rpc";
97
* ```
8+
*
9+
* @module
1010
*/
1111

1212
export * from "npm:@effect/[email protected]";

effect/rpc/http.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
/**
2-
* @module
3-
*
42
* Re-exports of `@effect/rpc-http` modules.
53
*
64
* @example
75
* ```ts
86
* import { RpcHttp } from "@totto/function/effect/rpc/http";
97
* ```
8+
*
9+
* @module
1010
*/
1111

1212
export * from "npm:@effect/[email protected]";

effect/test/deno.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,4 @@
11
/**
2-
* @module
3-
*
42
* Test utilities for Effect and Deno.
53
*
64
* Ignoring some Deno warnings due to test clock leaks.
@@ -14,6 +12,8 @@
1412
* () => Effect.sync(() => expect(1).toEqual(1)),
1513
* );
1614
* ```
15+
*
16+
* @module
1717
*/
1818
// deno-lint-ignore-file no-namespace
1919
import type {

effect/typeclass.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
/**
2-
* @module
3-
*
42
* Re-exports of `@effect/typeclass` modules.
53
*
64
* @example
75
* ```ts
86
* import { TypeClass } from "@totto/function/effect/typeclass";
97
* ```
8+
9+
* @module
1010
*/
1111

1212
export * from "npm:@effect/[email protected]";

option-t.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
/**
2-
* @module
3-
*
42
* Re-exports of `option-t` modules.
53
*
64
* @example
75
* ```ts
86
* import { Result } from "@totto/function/option-t";
97
* ```
8+
9+
* @module
1010
*/
1111

1212
export * from "npm:[email protected]";

option-t/effect.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,4 @@
11
/**
2-
* @module
3-
*
42
* Converts Effect's `Exit` to a Option-t's `Result`.
53
*
64
* @example
@@ -10,6 +8,8 @@
108
* const result = fromExit(Exit.succeed("success"));
119
* // result: Result.Ok("success")
1210
* ```
11+
12+
* @module
1313
*/
1414

1515
import { type Cause, Exit, Function } from "../effect.ts";

option-t/safe-try.ts

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
/*
1+
/**
22
* This is a port of [neverthrow](https://github.com/supermacro/neverthrow)'s `safeUnwrap` and `safeTry` to [option-t](https://github.com/gcanti/option-t).
33
*
44
* https://github.com/supermacro/neverthrow/blob/master/src/result.ts
@@ -25,6 +25,8 @@
2525
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
2626
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
2727
* SOFTWARE.
28+
29+
* @module
2830
*/
2931

3032
import { Result as R } from "../option-t.ts";

test.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
/**
2-
* @module
3-
*
42
* Re-exports of @std/testing modules.
53
*
64
* @example
75
* ```ts
86
* import { test } from "@totto/function/test";
97
* ```
8+
*
9+
* @module
1010
*/
1111

1212
export * from "jsr:@std/[email protected]";

0 commit comments

Comments
 (0)