feat(streams/unstable): toBytes() (#6011)

_tools/check_docs.ts

@@ -89,6 +89,7 @@ const ENTRY_POINTS = [
   "../streams/mod.ts",
   "../streams/unstable_fixed_chunk_stream.ts",
   "../streams/unstable_to_lines.ts",
+  "../streams/unstable_to_bytes.ts",
   "../tar/mod.ts",
   "../text/mod.ts",
   "../text/unstable_slugify.ts",

streams/deno.json

@@ -16,6 +16,7 @@
     "./text-line-stream": "./text_line_stream.ts",
     "./to-array-buffer": "./to_array_buffer.ts",
     "./to-blob": "./to_blob.ts",
+    "./unstable-to-bytes": "./unstable_to_bytes.ts",
     "./to-json": "./to_json.ts",
     "./unstable-to-lines": "./unstable_to_lines.ts",
     "./to-text": "./to_text.ts",

streams/unstable_to_bytes.ts

@@ -0,0 +1,30 @@
+// Copyright 2018-2024 the Deno authors. All rights reserved. MIT license.
+// This module is browser compatible.
+
+/**
+ * Converts a {@linkcode ReadableStream} of {@linkcode Uint8Array}s to a
+ * {@linkcode Uint8Array}. Works the same as {@linkcode Response.bytes}.
+ *
+ * @experimental **UNSTABLE**: New API, yet to be vetted.
+ *
+ * @param stream A `ReadableStream` of `Uint8Array`s to convert into a `Uint8Array`.
+ * @returns A `Promise` that resolves to the `Uint8Array`.
+ *
+ * @example Basic usage
+ * ```ts
+ * import { toBytes } from "@std/streams/unstable-to-bytes";
+ * import { assertEquals } from "@std/assert";
+ *
+ * const stream = ReadableStream.from([
+ *   new Uint8Array([1, 2]),
+ *   new Uint8Array([3, 4, 5]),
+ * ]);
+ * const bytes = await toBytes(stream);
+ * assertEquals(bytes, new Uint8Array([1, 2, 3, 4, 5]));
+ * ```
+ */
+export function toBytes(
+  stream: ReadableStream<Uint8Array>,
+): Promise<Uint8Array> {
+  return new Response(stream).bytes();
+}

streams/unstable_to_bytes_test.ts

@@ -0,0 +1,17 @@
+// Copyright 2018-2024 the Deno authors. All rights reserved. MIT license.
+import { assertEquals } from "@std/assert";
+import { toBytes } from "./unstable_to_bytes.ts";
+
+Deno.test("toBytes()", async () => {
+  const stream = ReadableStream.from([
+    new Uint8Array([1, 2, 3, 4, 5]),
+    new Uint8Array([6, 7]),
+    new Uint8Array([8, 9]),
+  ]);
+
+  const bytes = await toBytes(stream);
+  assertEquals(
+    await bytes.buffer,
+    new Uint8Array([1, 2, 3, 4, 5, 6, 7, 8, 9]).buffer,
+  );
+});