[minor] Rename some variables for clarity

websockets · Jan 5, 2018 · 1da7712 · 1da7712
1 parent f5d6a09
commit 1da7712
Show file tree

Hide file tree

Showing 2 changed files with 33 additions and 33 deletions.
diff --git a/lib/extension.js b/lib/extension.js
@@ -188,21 +188,21 @@ function parse (header) {
 }
 
 /**
- * Serializes a parsed `Sec-WebSocket-Extensions` header to a string.
+ * Builds the `Sec-WebSocket-Extensions` header field value.
  *
- * @param {Object} value The object to format
- * @return {String} A string representing the given value
+ * @param {Object} extensions The map of extensions and parameters to format
+ * @return {String} A string representing the given object
  * @public
  */
-function format (value) {
-  return Object.keys(value).map((token) => {
-    var paramsList = value[token];
-    if (!Array.isArray(paramsList)) paramsList = [paramsList];
-    return paramsList.map((params) => {
-      return [token].concat(Object.keys(params).map((k) => {
-        var p = params[k];
-        if (!Array.isArray(p)) p = [p];
-        return p.map((v) => v === true ? k : `${k}=${v}`).join('; ');
+function format (extensions) {
+  return Object.keys(extensions).map((extension) => {
+    var configurations = extensions[extension];
+    if (!Array.isArray(configurations)) configurations = [configurations];
+    return configurations.map((params) => {
+      return [extension].concat(Object.keys(params).map((k) => {
+        var values = params[k];
+        if (!Array.isArray(values)) values = [values];
+        return values.map((v) => v === true ? k : `${k}=${v}`).join('; ');
       })).join('; ');
     }).join(', ');
   }).join(', ');

diff --git a/lib/permessage-deflate.js b/lib/permessage-deflate.js
@@ -82,7 +82,7 @@ class PerMessageDeflate {
   }
 
   /**
-   * Create extension parameters offer.
+   * Create an extension negotiation offer.
    *
    * @return {Object} Extension parameters
    * @public
@@ -109,18 +109,18 @@ class PerMessageDeflate {
   }
 
   /**
-   * Accept extension offer.
+   * Accept an extension negotiation offer/response.
    *
-   * @param {Array} paramsList Extension parameters
+   * @param {Array} configurations The extension negotiation offers/reponse
    * @return {Object} Accepted configuration
    * @public
    */
-  accept (paramsList) {
-    paramsList = this.normalizeParams(paramsList);
+  accept (configurations) {
+    configurations = this.normalizeParams(configurations);
 
     this.params = this._isServer
-      ? this.acceptAsServer(paramsList)
-      : this.acceptAsClient(paramsList);
+      ? this.acceptAsServer(configurations)
+      : this.acceptAsClient(configurations);
 
     return this.params;
   }
@@ -150,15 +150,15 @@ class PerMessageDeflate {
   }
 
   /**
-   * Accept extension offer from client.
+   *  Accept an extension negotiation offer.
    *
-   * @param {Array} paramsList Extension parameters
+   * @param {Array} offers The extension negotiation offers
    * @return {Object} Accepted configuration
    * @private
    */
-  acceptAsServer (paramsList) {
+  acceptAsServer (offers) {
     const opts = this._options;
-    const accepted = paramsList.find((params) => {
+    const accepted = offers.find((params) => {
       if (
         (opts.serverNoContextTakeover === false &&
           params.server_no_context_takeover) ||
@@ -201,14 +201,14 @@ class PerMessageDeflate {
   }
 
   /**
-   * Accept extension response from server.
+   * Accept the extension negotiation response.
    *
-   * @param {Array} paramsList Extension parameters
+   * @param {Array} response The extension negotiation response
    * @return {Object} Accepted configuration
    * @private
    */
-  acceptAsClient (paramsList) {
-    const params = paramsList[0];
+  acceptAsClient (response) {
+    const params = response[0];
 
     if (
       this._options.clientNoContextTakeover === false &&
@@ -235,14 +235,14 @@ class PerMessageDeflate {
   }
 
   /**
-   * Normalize extensions parameters.
+   * Normalize parameters.
    *
-   * @param {Array} paramsList Extension parameters
-   * @return {Array} Normalized extensions parameters
+   * @param {Array} configurations The extension negotiation offers/reponse
+   * @return {Array} The offers/response with normalized parameters
    * @private
    */
-  normalizeParams (paramsList) {
-    paramsList.forEach((params) => {
+  normalizeParams (configurations) {
+    configurations.forEach((params) => {
       Object.keys(params).forEach((key) => {
         var value = params[key];
 
@@ -291,7 +291,7 @@ class PerMessageDeflate {
       });
     });
 
-    return paramsList;
+    return configurations;
   }
 
   /**