braid-http 1.3.59 → 1.3.61

package/README.md

@@ -1,11 +1,18 @@
 # Braid-HTTP
 
-This polyfill library implements the [Braid-HTTP v04
-protocol](https://github.com/braid-org/braid-spec/blob/master/draft-toomim-httpbis-braid-http-04.txt),
-with [HTTP Multiresponse](https://braid.org/meeting-89), and [Multiplexing
-v1.0](https://braid.org/protocol/multiplexing).  It provides browsers with a
-`braid_fetch()` drop-in replacement for the `fetch()` API, and offers nodejs
-an `http` plugin, enabling simple Braid communication.
+This [ponyfill](https://ponyfill.com/) library extends the HTTP
+implementations of Browsers and Nodejs with Braid-HTTP; transforming them from
+*state transfer* to *state synchronization* systems.
+
+These features are provided in an elegant, backwards-compatible way:
+- Browsers: get a drop-in replacement for `fetch()`
+- Nodejs: get a route handler that adds abilities to the `http`, `https`, and `http2` modules
+
+It conforms to the [Braid-HTTP
+v04](https://github.com/braid-org/braid-spec/blob/master/draft-toomim-httpbis-braid-http-04.txt)
+specification, with the additional [HTTP
+Multiresponse](https://braid.org/meeting-89) and [Multiplexing
+v1.0](https://braid.org/protocol/multiplexing) extensions.
 
 Developed in [braid.org](https://braid.org).
 
@@ -163,7 +170,7 @@ require('http').createServer(
             version: ['greg'],
             body: JSON.stringify({greg: 'greg'})
         })
-    }
+    })
 ).listen(9935)
 ```
 
@@ -284,4 +291,4 @@ response connection dies, and thus you cannot attach a `.catch()` handler to
 automatically reconnect.  (See
 [issue #980](https://github.com/node-fetch/node-fetch/issues/980) and
 [#753](https://github.com/node-fetch/node-fetch/issues/753).)  We recommend
-using the `http` library (below) for requests on nodejs instead.
+using the `http` client on nodejs instead.

package/braid-http-client.js

@@ -949,7 +949,7 @@ async function create_multiplexer(origin, mux_key, params, mux_params, attempt)
         if (!try_deleting.has(request)) {
             try_deleting.add(request)
             try {
-                var mux_was_done = await promise_done(mux_promise)
+                var mux_was_done = await promise_done(mux_created_promise)
 
                 var r = await braid_fetch(`${origin}/.well-known/multiplexer/${multiplexer}/${request}`, {
                     method: 'DELETE',
@@ -979,7 +979,10 @@ async function create_multiplexer(origin, mux_key, params, mux_params, attempt)
         }
     }
 
-    var mux_promise = (async () => {
+    // This promise resolves when the create_multiplexer request responds.
+    //  - its value is undefined if successfully created
+    //  - its value is false if creation failed
+    var mux_created_promise = (async () => {
         // attempt to establish a multiplexed connection
         try {
             if (mux_params?.via === 'POST') throw 'skip multiplex method'
@@ -1039,7 +1042,7 @@ async function create_multiplexer(origin, mux_key, params, mux_params, attempt)
 
         // if we already know the multiplexer is not working,
         // then fallback to normal fetch
-        if ((await promise_done(mux_promise)) && (await mux_promise) === false) {
+        if ((await promise_done(mux_created_promise)) && (await mux_created_promise) === false) {
             // if the user is specifically asking for multiplexing,
             // throw an error instead
             if (params.headers.get('multiplex-through')) throw new Error('multiplexer failed')
@@ -1105,7 +1108,7 @@ async function create_multiplexer(origin, mux_key, params, mux_params, attempt)
 
         // do the underlying fetch
         try {
-            var mux_was_done = await promise_done(mux_promise)
+            var mux_was_done = await promise_done(mux_created_promise)
 
             // callback for testing
             mux_params?.onFetch?.(url, params)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "braid-http",
-  "version": "1.3.59",
+  "version": "1.3.61",
   "description": "An implementation of Braid-HTTP for Node.js and Browsers",
   "scripts": {
     "test": "node test/server.js"
@@ -29,5 +29,8 @@
     "node-fetch": "^2.6.1",
     "parse-headers": "^2.0.3",
     "web-streams-node": "^0.4.0"
+  },
+  "devDependencies": {
+    "express": "^4.21.2"
   }
 }