Creating decoratorSet() to decorate res.set() for better interop …

…with express middleware & adding a test, updating README.md, updating decorators
avoidwork · Oct 11, 2023 · 91a33f3 · 91a33f3
1 parent eccc701
commit 91a33f3
Show file tree

Hide file tree

Showing 7 changed files with 56 additions and 25 deletions.
diff --git a/README.md b/README.md
@@ -42,8 +42,8 @@ Woodland has 100% code coverage with its tests; the missing 0.22% is hard to rea
 --------------|---------|----------|---------|---------|-------------------------------
 File          | % Stmts | % Branch | % Funcs | % Lines | Uncovered Line #s
 --------------|---------|----------|---------|---------|-------------------------------
-All files     |   99.78 |    76.26 |   98.52 |     100 | 
- woodland.cjs |   99.78 |    76.26 |   98.52 |     100 | ...214,254,275-285,314-328,...
+All files     |   99.78 |    76.02 |   98.57 |     100 | 
+ woodland.cjs |   99.78 |    76.02 |   98.57 |     100 | ...214,254,275-285,314-328,...
 --------------|---------|----------|---------|---------|-------------------------------
 ```
 
@@ -230,6 +230,9 @@ Sends a redirection response.
 ### res.send(body, [status = 200, headers = {}])
 Sends a response. `Range` header is ignored on `stream` responses.
 
+### res.set(headers = {})
+Shorthand of `res.setHeaders()` which accepts `Object`, `Map`, or `Headers` instances.
+
 ### res.status(arg)
 Sets the response `statusCode` property.
 

diff --git a/dist/woodland.cjs b/dist/woodland.cjs
@@ -3,7 +3,7 @@
  *
  * @copyright 2023 Jason Mulligan <jason.mulligan@avoidwork.com>
  * @license BSD-3-Clause
- * @version 18.0.16
+ * @version 18.1.0
  */
 'use strict';
 
@@ -474,13 +474,13 @@ class Woodland extends node_events.EventEmitter {
 		};
 	}
 
-	decoratorJson (req, res) {
+	decoratorJson (res) {
 		return (arg, status = 200, headers = {[CONTENT_TYPE]: `${APPLICATION_JSON}; charset=${UTF_8}`}) => {
 			res.send(JSON.stringify(arg), status, headers);
 		};
 	}
 
-	decoratorRedirect (req, res) {
+	decoratorRedirect (res) {
 		return (uri, perm = true) => {
 			res.send(EMPTY, perm ? 301 : 302, {[LOCATION]: uri});
 		};
@@ -529,7 +529,15 @@ class Woodland extends node_events.EventEmitter {
 		};
 	}
 
-	decoratorStatus (req, res) {
+	decoratorSet (res) {
+		return (arg = {}) => {
+			res.setHeaders(arg instanceof Map || arg instanceof Headers ? arg : new Headers(arg));
+
+			return res;
+		};
+	}
+
+	decoratorStatus (res) {
 		return (arg = 200) => {
 			res.statusCode = arg;
 
@@ -555,10 +563,11 @@ class Woodland extends node_events.EventEmitter {
 		res.locals = {};
 		res.error = this.decoratorError(req, res);
 		res.header = res.setHeader;
-		res.json = this.decoratorJson(req, res);
-		res.redirect = this.decoratorRedirect(req, res);
+		res.json = this.decoratorJson(res);
+		res.redirect = this.decoratorRedirect(res);
 		res.send = this.decoratorSend(req, res);
-		res.status = this.decoratorStatus(req, res);
+		res.set = this.decoratorSet(res);
+		res.status = this.decoratorStatus(res);
 
 		for (const i of this.defaultHeaders) {
 			res.header(i[0], i[1]);

diff --git a/dist/woodland.js b/dist/woodland.js
@@ -3,7 +3,7 @@
  *
  * @copyright 2023 Jason Mulligan <jason.mulligan@avoidwork.com>
  * @license BSD-3-Clause
- * @version 18.0.16
+ * @version 18.1.0
  */
 import {STATUS_CODES,METHODS}from'node:http';import {join,extname,resolve}from'node:path';import {EventEmitter}from'node:events';import {stat,readdir}from'node:fs/promises';import {etag}from'tiny-etag';import {precise}from'precise';import {lru}from'tiny-lru';import {readFileSync,createReadStream}from'node:fs';import {fileURLToPath,URL}from'node:url';import {coerce}from'tiny-coerce';import mimeDb from'mime-db';const ACCESS_CONTROL_ALLOW_CREDENTIALS = "access-control-allow-credentials";
 const ACCESS_CONTROL_ALLOW_HEADERS = "access-control-allow-headers";
@@ -455,13 +455,13 @@ function writeHead (res, headers = {}) {
 		};
 	}
 
-	decoratorJson (req, res) {
+	decoratorJson (res) {
 		return (arg, status = 200, headers = {[CONTENT_TYPE]: `${APPLICATION_JSON}; charset=${UTF_8}`}) => {
 			res.send(JSON.stringify(arg), status, headers);
 		};
 	}
 
-	decoratorRedirect (req, res) {
+	decoratorRedirect (res) {
 		return (uri, perm = true) => {
 			res.send(EMPTY, perm ? 301 : 302, {[LOCATION]: uri});
 		};
@@ -510,7 +510,15 @@ function writeHead (res, headers = {}) {
 		};
 	}
 
-	decoratorStatus (req, res) {
+	decoratorSet (res) {
+		return (arg = {}) => {
+			res.setHeaders(arg instanceof Map || arg instanceof Headers ? arg : new Headers(arg));
+
+			return res;
+		};
+	}
+
+	decoratorStatus (res) {
 		return (arg = 200) => {
 			res.statusCode = arg;
 
@@ -536,10 +544,11 @@ function writeHead (res, headers = {}) {
 		res.locals = {};
 		res.error = this.decoratorError(req, res);
 		res.header = res.setHeader;
-		res.json = this.decoratorJson(req, res);
-		res.redirect = this.decoratorRedirect(req, res);
+		res.json = this.decoratorJson(res);
+		res.redirect = this.decoratorRedirect(res);
 		res.send = this.decoratorSend(req, res);
-		res.status = this.decoratorStatus(req, res);
+		res.set = this.decoratorSet(res);
+		res.status = this.decoratorStatus(res);
 
 		for (const i of this.defaultHeaders) {
 			res.header(i[0], i[1]);

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "woodland",
-  "version": "18.0.16",
+  "version": "18.1.0",
   "description": "Lightweight HTTP framework with automatic headers",
   "type": "module",
   "types": "types/woodland.d.ts",

diff --git a/src/woodland.js b/src/woodland.js
@@ -238,13 +238,13 @@ export class Woodland extends EventEmitter {
 		};
 	}
 
-	decoratorJson (req, res) {
+	decoratorJson (res) {
 		return (arg, status = 200, headers = {[CONTENT_TYPE]: `${APPLICATION_JSON}; charset=${UTF_8}`}) => {
 			res.send(JSON.stringify(arg), status, headers);
 		};
 	}
 
-	decoratorRedirect (req, res) {
+	decoratorRedirect (res) {
 		return (uri, perm = true) => {
 			res.send(EMPTY, perm ? 301 : 302, {[LOCATION]: uri});
 		};
@@ -293,7 +293,15 @@ export class Woodland extends EventEmitter {
 		};
 	}
 
-	decoratorStatus (req, res) {
+	decoratorSet (res) {
+		return (arg = {}) => {
+			res.setHeaders(arg instanceof Map || arg instanceof Headers ? arg : new Headers(arg));
+
+			return res;
+		};
+	}
+
+	decoratorStatus (res) {
 		return (arg = 200) => {
 			res.statusCode = arg;
 
@@ -319,10 +327,11 @@ export class Woodland extends EventEmitter {
 		res.locals = {};
 		res.error = this.decoratorError(req, res);
 		res.header = res.setHeader;
-		res.json = this.decoratorJson(req, res);
-		res.redirect = this.decoratorRedirect(req, res);
+		res.json = this.decoratorJson(res);
+		res.redirect = this.decoratorRedirect(res);
 		res.send = this.decoratorSend(req, res);
-		res.status = this.decoratorStatus(req, res);
+		res.set = this.decoratorSet(res);
+		res.status = this.decoratorStatus(res);
 
 		for (const i of this.defaultHeaders) {
 			res.header(i[0], i[1]);

diff --git a/test/test.js b/test/test.js
@@ -47,6 +47,7 @@ const router = woodland({
 
 function always (req, res, next) {
 	res.header("x-always", "true");
+	res.set({"x-other-stuff": "true"});
 	next();
 }