@serwist/streams 9.0.0-preview.0 → 9.0.0-preview.1

package/dist/index.js

@@ -1,16 +1,7 @@
 import { assert, Deferred, logger, SerwistError, canConstructReadableStream } from '@serwist/core/internal';
 
-/**
- * Takes either a Response, a ReadableStream, or a
- * [BodyInit](https://fetch.spec.whatwg.org/#bodyinit) and returns the
- * ReadableStreamReader object associated with it.
- *
- * @param source
- * @returns
- * @private
- */ function _getReaderFromSource(source) {
+function _getReaderFromSource(source) {
     if (source instanceof Response) {
-        // See https://github.com/GoogleChrome/workbox/issues/2998
         if (source.body) {
             return source.body.getReader();
         }
@@ -23,17 +14,7 @@ import { assert, Deferred, logger, SerwistError, canConstructReadableStream } fr
     }
     return new Response(source).body.getReader();
 }
-/**
- * Takes multiple source Promises, each of which could resolve to a Response, a
- * ReadableStream, or a [BodyInit](https://fetch.spec.whatwg.org/#bodyinit).
- *
- * Returns an object exposing a ReadableStream with each individual stream's
- * data returned in sequence, along with a Promise which signals when the
- * stream is finished (useful for passing to a FetchEvent's waitUntil()).
- *
- * @param sourcePromises
- * @returns
- */ function concatenate(sourcePromises) {
+function concatenate(sourcePromises) {
     if (process.env.NODE_ENV !== "production") {
         assert.isArray(sourcePromises, {
             moduleName: "@serwist/streams",
@@ -66,7 +47,6 @@ import { assert, Deferred, logger, SerwistError, canConstructReadableStream } fr
                     }
                     i++;
                     if (i >= readerPromises.length) {
-                        // Log all the messages in the group at once in a single group.
                         if (process.env.NODE_ENV !== "production") {
                             logger.groupCollapsed(`Concatenating ${readerPromises.length} sources.`);
                             for (const message of logMessages){
@@ -83,7 +63,6 @@ import { assert, Deferred, logger, SerwistError, canConstructReadableStream } fr
                         streamDeferred.resolve();
                         return;
                     }
-                    // The `pull` method is defined because we're inside it.
                     return this.pull(controller);
                 }
                 controller.enqueue(result?.value);
@@ -108,24 +87,7 @@ import { assert, Deferred, logger, SerwistError, canConstructReadableStream } fr
     };
 }
 
-/*
-  Copyright 2018 Google LLC
-
-  Use of this source code is governed by an MIT-style
-  license that can be found in the LICENSE file or at
-  https://opensource.org/licenses/MIT.
-*/ /**
- * This is a utility method that determines whether the current browser supports
- * the features required to create streamed responses. Currently, it checks if
- * [`ReadableStream`](https://developer.mozilla.org/en-US/docs/Web/API/ReadableStream/ReadableStream)
- * is available.
- *
- * @private
- * @param headersInit If there's no `Content-Type` specified, `'text/html'` will be used by default.
- * @returns `true`, if the current browser meets the requirements for
- * streaming responses, and `false` otherwise.
- */ function createHeaders(headersInit = {}) {
-    // See https://github.com/GoogleChrome/workbox/issues/1461
+function createHeaders(headersInit = {}) {
     const headers = new Headers(headersInit);
     if (!headers.has("content-type")) {
         headers.set("content-type", "text/html");
@@ -133,20 +95,7 @@ import { assert, Deferred, logger, SerwistError, canConstructReadableStream } fr
     return headers;
 }
 
-/**
- * Takes multiple source Promises, each of which could resolve to a Response, a
- * ReadableStream, or a [BodyInit](https://fetch.spec.whatwg.org/#bodyinit),
- * along with a
- * [HeadersInit](https://fetch.spec.whatwg.org/#typedefdef-headersinit).
- *
- * Returns an object exposing a Response whose body consists of each individual
- * stream's data returned in sequence, along with a Promise which signals when
- * the stream is finished (useful for passing to a FetchEvent's waitUntil()).
- *
- * @param sourcePromises
- * @param headersInit If there's no `Content-Type` specified,`'text/html'` will be used by default.
- * @returns
- */ function concatenateToResponse(sourcePromises, headersInit) {
+function concatenateToResponse(sourcePromises, headersInit) {
     const { done, stream } = concatenate(sourcePromises);
     const headers = createHeaders(headersInit);
     const response = new Response(stream, {
@@ -158,33 +107,13 @@ import { assert, Deferred, logger, SerwistError, canConstructReadableStream } fr
     };
 }
 
-/**
- * This is a utility method that determines whether the current browser supports
- * the features required to create streamed responses. Currently, it checks if
- * [`ReadableStream`](https://developer.mozilla.org/en-US/docs/Web/API/ReadableStream/ReadableStream)
- * can be created.
- *
- * @returns `true`, if the current browser meets the requirements for
- * streaming responses, and `false` otherwise.
- */ function isSupported() {
+function isSupported() {
     return canConstructReadableStream();
 }
 
-/**
- * A shortcut to create a strategy that could be dropped-in to Serwist's router.
- *
- * On browsers that do not support constructing new `ReadableStream`s, this
- * strategy will automatically wait for all the `sourceFunctions` to complete,
- * and create a final response that concatenates their values together.
- *
- * @param sourceFunctions An array of functions similar to `@serwist/routing.handlerCallback`
- * but that instead return a `@serwist/streams.StreamSource` (or a Promise which resolves to one).
- * @param headersInit If there's no `Content-Type` specified, `'text/html'` will be used by default.
- * @returns
- */ function strategy(sourceFunctions, headersInit) {
+function strategy(sourceFunctions, headersInit) {
     return async ({ event, request, url, params })=>{
         const sourcePromises = sourceFunctions.map((fn)=>{
-            // Ensure the return value of the function is always a promise.
             return Promise.resolve(fn({
                 event,
                 request,
@@ -202,23 +131,15 @@ import { assert, Deferred, logger, SerwistError, canConstructReadableStream } fr
         if (process.env.NODE_ENV !== "production") {
             logger.log(`The current browser doesn't support creating response ` + "streams. Falling back to non-streaming response instead.");
         }
-        // Fallback to waiting for everything to finish, and concatenating the
-        // responses.
         const blobPartsPromises = sourcePromises.map(async (sourcePromise)=>{
             const source = await sourcePromise;
             if (source instanceof Response) {
                 return source.blob();
             }
-            // Technically, a `StreamSource` object can include any valid
-            // `BodyInit` type, including `FormData` and `URLSearchParams`, which
-            // cannot be passed to the Blob constructor directly, so we have to
-            // convert them to actual Blobs first.
             return new Response(source).blob();
         });
         const blobParts = await Promise.all(blobPartsPromises);
         const headers = createHeaders(headersInit);
-        // Constructing a new Response from a Blob source is well-supported.
-        // So is constructing a new Blob from multiple source Blobs or strings.
         return new Response(new Blob(blobParts), {
             headers
         });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@serwist/streams",
-  "version": "9.0.0-preview.0",
+  "version": "9.0.0-preview.1",
   "type": "module",
   "description": "A library that makes it easier to work with Streams in the browser.",
   "files": [
@@ -30,13 +30,13 @@
     "./package.json": "./package.json"
   },
   "dependencies": {
-    "@serwist/core": "9.0.0-preview.0",
-    "@serwist/routing": "9.0.0-preview.0"
+    "@serwist/core": "9.0.0-preview.1",
+    "@serwist/routing": "9.0.0-preview.1"
   },
   "devDependencies": {
     "rollup": "4.9.6",
     "typescript": "5.4.0-dev.20240203",
-    "@serwist/constants": "9.0.0-preview.0"
+    "@serwist/constants": "9.0.0-preview.1"
   },
   "peerDependencies": {
     "typescript": ">=5.0.0"