📖 文档补充

Gaubee · Oct 10, 2024 · 4217fed · 4217fed
1 parent 90359ac
commit 4217fed
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 2 deletions.
diff --git a/deno.json b/deno.json
@@ -1,6 +1,6 @@
 {
     "name": "@gaubee/util",
-    "version": "0.9.0",
+    "version": "0.9.1",
     "tasks": {
         "build": "deno run -A ./dnt.ts",
         "npm": "deno task build && deno task pub-npm",

diff --git a/src/readable_stream.ts b/src/readable_stream.ts
@@ -17,6 +17,13 @@ interface ReadableByteWithController {
     <R>(strategy?: QueuingStrategy<R> & { type?: undefined }): ReadableDefaultStreamWithController<R>;
     (strategy?: QueuingStrategy<Uint8Array> & { type: "bytes" }): ReadableByteStreamWithController;
 }
+/**
+ * 一个易用的 ReadableStream 构造函数
+ * - 直接暴露了 controller 对象
+ * - pull/cancel 使用 SharedFlow 来暴露
+ * @param strategy
+ * @returns
+ */
 const withController: ReadableByteWithController = <R>(strategy?: QueuingStrategy<R> & { type?: "bytes" }) => {
     const result = obj_lazify<any>({
         get onPull() {

diff --git a/src/shared_flow.ts b/src/shared_flow.ts
@@ -1,5 +1,5 @@
 import { iter_map_async } from "./collections.ts";
-import { Func } from "./func.ts";
+import type { Func } from "./func.ts";
 import { type ReadableDefaultStreamWithController, rs_with_controller } from "./readable_stream.ts";
 
 /** SharedFlow 的监听函数定义 */