From: Justin Wind <justin.wind+git@gmail.com>
Date: Thu, 27 Mar 2025 19:35:06 +0000 (-0700)
Subject: minor doc updates
X-Git-Tag: v2.1.3^2~2
X-Git-Url: https://git.squeep.com/?a=commitdiff_plain;h=52f5ab68700c60c7f4cee05ba736ce54fbcb7722;p=squeep-api-dingus

minor doc updates
---

diff --git a/CHANGELOG.md b/CHANGELOG.md
index c39cea5..378c296 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -4,6 +4,8 @@ Releases and notable changes to this project are documented here.
 
 ## [Unreleased]
 
+- updated dependencies and devDependencies
+
 ## [v2.1.2] - 2024-06-08
 
 - addCookie helper does more validation
diff --git a/lib/common.js b/lib/common.js
index 2f0aeb8..4e4fd4e 100644
--- a/lib/common.js
+++ b/lib/common.js
@@ -12,12 +12,13 @@ const { fileScope } = require('@squeep/log-helper');
 
 /**
  * @typedef {import('node:http')} http
+ * @typedef {import('node:fs')} fs
  */
 
 /**
  * Simple ETag from data.
  * @param {string} _filePath (currently unused)
- * @param {object} fileStat node:fs.Stats object
+ * @param {fs.Stats} fileStat node:fs.Stats object
  * @param {number} fileStat.mtimeMs node:fs.Stats object
  * @param {crypto.BinaryLike} fileData content
  * @returns {string} etag
diff --git a/test/lib/common.js b/test/lib/common.js
index 06d711d..e1e47c4 100644
--- a/test/lib/common.js
+++ b/test/lib/common.js
@@ -5,7 +5,7 @@ const sinon = require('sinon');
 const common = require('../../lib/common');
 
 
-describe('common', function () {
+describe('Common', function () {
 
   describe('generateETag', function () {
     it('generates a tag from data', function () {
@@ -419,4 +419,4 @@ describe('common', function () {
     });
   }); // addCookie
 
-});
+}); // Common
diff --git a/test/lib/dingus.js b/test/lib/dingus.js
index 9e8d4ce..ae3d746 100644
--- a/test/lib/dingus.js
+++ b/test/lib/dingus.js
@@ -2,7 +2,7 @@
 
 const assert = require('node:assert');
 const sinon = require('sinon');
-const fs = require('fs');
+const fs = require('node:fs');
 
 const Dingus = require('../../lib/dingus');
 const { DingusError, RouterNoMethodError } = require('../../lib/errors');
@@ -154,7 +154,7 @@ describe('Dingus', function () {
       };
       ctx = {};
     });
-    it ('covers untrusted proxy', function () {
+    it('covers untrusted proxy', function () {
       dingus.trustProxy = false;
       const expected = {
         clientAddress: '',
@@ -164,7 +164,7 @@ describe('Dingus', function () {
       assert.deepStrictEqual(ctx, expected);
       assert(!req.getHeader.called);
     });
-    it ('covers missing', function () {
+    it('covers missing', function () {
       dingus.trustProxy = true;
       const expected = {
         clientAddress: '::1',
@@ -1134,4 +1134,4 @@ Content-Type: image/sgi
       assert(dingus.serveFile.called);
     });
   }); // handlerGetStaticFile
-});
+}); // Dingus
diff --git a/test/lib/enum.js b/test/lib/enum.js
index a9be982..ee702c6 100644
--- a/test/lib/enum.js
+++ b/test/lib/enum.js
@@ -40,4 +40,4 @@ describe('Enum', function () {
     });
   }); // ErrorResponse
 
-});
+}); // Enum
diff --git a/test/lib/mime-helper.js b/test/lib/mime-helper.js
index b142ed3..4fba277 100644
--- a/test/lib/mime-helper.js
+++ b/test/lib/mime-helper.js
@@ -3,7 +3,7 @@
 const assert = require('node:assert');
 const MimeHelper = require('../../lib/mime-helper');
 
-describe('ext-to-mime', function () {
+describe('MimeHelper', function () {
 
   describe('extensionToMime', function () {
     it('returns default for unknown extension', function () {
@@ -23,4 +23,4 @@ describe('ext-to-mime', function () {
     });
   }); // extensionToMime
 
-});
+}); // MimeHelper
diff --git a/test/lib/patches/incoming-message.js b/test/lib/patches/incoming-message.js
index d117c90..a5d2239 100644
--- a/test/lib/patches/incoming-message.js
+++ b/test/lib/patches/incoming-message.js
@@ -4,7 +4,7 @@ const assert = require('node:assert');
 const { IncomingMessage } = require('node:http');
 require('../../../lib/patches/incoming-message');
 
-describe('IncomingMessage.getHeader', function () {
+describe('Patch IncomingMessage.getHeader', function () {
   let im;
   beforeEach(function () {
     im = new IncomingMessage();
@@ -30,5 +30,5 @@ describe('IncomingMessage.getHeader', function () {
     const result = im.getHeader(name);
     assert.strictEqual(result, value);
   });
-});
+}); // Patch IncomingMessage.getHeader
 
diff --git a/test/lib/router.js b/test/lib/router.js
index 4047b16..e5bba38 100644
--- a/test/lib/router.js
+++ b/test/lib/router.js
@@ -367,4 +367,4 @@ describe('Router', function () {
 
   }); // lookup
 
-});
+}); // Router
diff --git a/test/lib/router/path-parameter.js b/test/lib/router/path-parameter.js
index 8761b66..9f789fc 100644
--- a/test/lib/router/path-parameter.js
+++ b/test/lib/router/path-parameter.js
@@ -1,4 +1,3 @@
-/* eslint-env mocha */
 'use strict';
 
 const assert = require('node:assert');