braid-http 1.3.58 → 1.3.60

package/README.md

@@ -1,6 +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), modified slightly to follow the HTTP Multiresponse concept discussed at [braid.org/meeting-89](https://braid.org/meeting-89). 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).
 
@@ -143,30 +155,29 @@ var braidify = require('braid-http').http_server
 import {http_server as braidify} from 'braid-http'
 
 require('http').createServer(
-    (req, res) => {
-        // Add braid stuff to req and res
-        braidify(req, res)
+    braidify((req, res) => {
+        // Now braid stuff is available on req and res
 
-        // Now use it
+        // So you can easily handle subscriptions
         if (req.subscribe)
             res.startSubscription({ onClose: _=> null })
             // startSubscription automatically sets statusCode = 209
         else
             res.statusCode = 200
 
-        // Send the current version
+        // And send updates over a subscription
         res.sendUpdate({
             version: ['greg'],
             body: JSON.stringify({greg: 'greg'})
         })
-    }
+    })
 ).listen(9935)
 ```
 
 ### Example Nodejs server with `require('express')`
 
-With `express`, you can simply call `app.use(braidify)` to get braid features
-added to every request and response.
+Or if you're using `express`, you can just call `app.use(braidify)` to get
+braid features added to every request and response.
 
 ```javascript
 var braidify = require('braid-http').http_server
@@ -280,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

@@ -900,14 +900,16 @@ async function multiplex_fetch(url, params, mux_params) {
     var mux_key = params.headers.get('multiplex-through')?.split('/')[3] ?? origin
 
     // create a new multiplexer if it doesn't exist for this origin
-    if (!multiplex_fetch.multiplexers)          multiplex_fetch.multiplexers = {}
+    if (!multiplex_fetch.multiplexers)
+        multiplex_fetch.multiplexers = {}
 
     // this for-loop allows us to retry right away,
     // in case of duplicate ids
     for (let attempt = 1; ; attempt++) {
         await new Promise(done => setTimeout(done, attempt >= 3 ? 1000 : 0))
 
-        if (!multiplex_fetch.multiplexers[mux_key]) multiplex_fetch.multiplexers[mux_key] =
+        // Create a multiplexer if it does not exist yet
+        multiplex_fetch.multiplexers[mux_key] ||=
             create_multiplexer(origin, mux_key, params, mux_params, attempt)
 
         // call the special fetch function for the multiplexer

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "braid-http",
-  "version": "1.3.58",
+  "version": "1.3.60",
   "description": "An implementation of Braid-HTTP for Node.js and Browsers",
   "scripts": {
     "test": "node test/server.js"