sprucehttp_sjs 1.0.8 → 1.0.10

package/README.md

@@ -9,6 +9,7 @@ A module for responding to requests within SpruceHTTP in an SJS file.
 	- [writeHeader(name, value)](#writeheadername-value)
 	- [writeData(data)](#writedatadata)
 	- [writeDataAsync(data)](#writedataasyncdata)
+	- [clearResponse()](#clearresponse)
 	- [siteConfig()](#siteconfig)
 	- [requestIP()](#requestip)
 	- [method()](#method)
@@ -96,6 +97,24 @@ const fs = require('fs');
 await sjs.writeDataAsync(fs.readFileSync("image.png", 'binary'));
 ```
 
+### ``clearResponse()``:
+Clears the currently written response and resets the status line, headers, and body.
+This is useful when you want to send a different response than the one you have already written.
+
+This function does not work in stream mode.
+
+```js
+sjs.writeStatusLine(418, "I'm a teapot");
+sjs.writeHeader("Content-Type", "text/html");
+sjs.writeData("<h1>I'm a teapot</h1>");
+// Be serious
+sjs.clearResponse();
+
+sjs.writeStatusLine(200);
+sjs.writeHeader("Content-Type", "text/html");
+sjs.writeData("<h1>I'm <i>not</i> a teapot</h1>");
+```
+
 ### ``siteConfig()``:
 Returns the site-specific configuration set in your config file.
 

package/index.js

@@ -1,3 +1,5 @@
+// This is still CommonJS to support both the old and new versions of the module system.
+// eslint-disable-next-line @typescript-eslint/no-var-requires
 const fs = require("fs");
 
 module.exports = {
@@ -6,20 +8,20 @@ module.exports = {
 	 * 
 	 * Stream mode means that responses are not buffered by the webserver.
 	 */
-	streamMode: function() {
+	streamMode: function () {
 		process.send({
-			type: 'streamMode'
+			type: "streamMode"
 		});
 	},
-	
+
 	/**
 	 * Writes the status line to the response.
 	 * @param {number} statusCode The HTTP status code to send.
 	 * @param {string} [reasonPhrase] The reason phrase to send.
 	 */
-	writeStatusLine: function(statusCode, reasonPhrase) {
+	writeStatusLine: function (statusCode, reasonPhrase) {
 		process.send({
-			type: 'status',
+			type: "status",
 			statusCode,
 			reasonPhrase
 		});
@@ -30,9 +32,9 @@ module.exports = {
 	 * @param {string} name The name of the header to send.
 	 * @param {string} value The value of the header to send.
 	 */
-	writeHeader: function(name, value) {
+	writeHeader: function (name, value) {
 		process.send({
-			type: 'header',
+			type: "header",
 			name,
 			value
 		});
@@ -44,8 +46,8 @@ module.exports = {
 	 * When not in stream mode, the Content-Length header is automatically updated.
 	 * @param {string | Buffer} data The data to send.
 	 */
-	writeData: function(data) {
-		(async () => {await this.writeDataAsync(data);})();
+	writeData: function (data) {
+		(async () => { await this.writeDataAsync(data); })();
 	},
 
 	/**
@@ -54,21 +56,33 @@ module.exports = {
 	 * When not in stream mode, the Content-Length header is automatically updated.
 	 * @param {string | Buffer} data The data to send.
 	 */
-	writeDataAsync: function(data) {
-		return new Promise(function(resolve) {
+	writeDataAsync: function (data) {
+		return new Promise(function (resolve) {
 			process.send({
-				type: 'data',
+				type: "data",
 				data: Buffer.from(data)
 			}, resolve);
 		});
 	},
 
+	/**
+	 * Clears the currently written response and resets the status line, headers, and body.
+	 * This is useful when you want to send a different response than the one you have already written.
+	 * 
+	 * This function does not work in stream mode.
+	 */
+	clearResponse: function () {
+		process.send({
+			type: "clear"
+		});
+	},
+
 	/**
 	 * Returns the site-specific configuration.
 	 * 
 	 * @returns {{[key: string]: string}} The site-specific configuration.
 	 */
-	siteConfig: function() {
+	siteConfig: function () {
 		return JSON.parse(process.env.siteConfig);
 	},
 
@@ -77,7 +91,7 @@ module.exports = {
 	 * 
 	 * @returns {string} The requestor's IP address.
 	 */
-	requestIP: function() {
+	requestIP: function () {
 		return process.env.reqIP;
 	},
 
@@ -86,8 +100,8 @@ module.exports = {
 	 * 
 	 * @returns {string} The request method.
 	 */
-	method: function() {
-		return process.env.reqMethod;
+	method: function () {
+		return process.env.reqMethod.toLowerCase();
 	},
 
 	/**
@@ -95,7 +109,7 @@ module.exports = {
 	 * 
 	 * @returns {string} The full request path.
 	 */
-	path: function() {
+	path: function () {
 		return process.env.reqPath;
 	},
 
@@ -104,7 +118,7 @@ module.exports = {
 	 * 
 	 * @returns {string} The request's info path.
 	 */
-	pathInfo: function() {
+	pathInfo: function () {
 		return process.env.reqPathInfo;
 	},
 
@@ -113,7 +127,7 @@ module.exports = {
 	 * 
 	 * @returns {{[key: string]: string}} The parsed query string of the request.
 	 */
-	query: function() {
+	query: function () {
 		return JSON.parse(process.env.reqQuery || "{}");
 	},
 
@@ -123,7 +137,7 @@ module.exports = {
 	 * @param {string} key The key of the query to get.
 	 * @returns {string} The value of the query parameter.
 	 */
-	queryValue: function(key) {
+	queryValue: function (key) {
 		return this.query()[key];
 	},
 
@@ -132,7 +146,7 @@ module.exports = {
 	 * 
 	 * @returns {string} The HTTP version of the request.
 	 */
-	httpVersion: function() {
+	httpVersion: function () {
 		return process.env.reqHttpVersion;
 	},
 
@@ -141,7 +155,7 @@ module.exports = {
 	 * 
 	 * @returns {{[key: string]: string}} The headers of the request.
 	 */
-	headers: function() {
+	headers: function () {
 		return JSON.parse(process.env.reqHeaders || "{}");
 	},
 
@@ -151,7 +165,7 @@ module.exports = {
 	 * @param {string} name The name of the header to get.
 	 * @returns {string} The value of the header.
 	 */
-	headerValue: function(name) {
+	headerValue: function (name) {
 		return this.headers()[name];
 	},
 
@@ -160,7 +174,7 @@ module.exports = {
 	 * 
 	 * @returns {Buffer} The body of the request.
 	 */
-	body: function() {
+	body: function () {
 		let retVal = undefined;
 		if (process.env.reqBody) {
 			retVal = fs.readFileSync(process.env.reqBody);
@@ -174,11 +188,11 @@ module.exports = {
 	 * @param {string | Object} [options] The options to pass to fs.createReadStream.
 	 * @returns {fs.ReadStream} A ReadStream of the body of the request.
 	 */
-	 bodyStream: function(options) {
+	bodyStream: function (options) {
 		let retVal = undefined;
 		if (process.env.reqBody) {
 			retVal = fs.createReadStream(process.env.reqBody, options);
 		}
 		return retVal;
 	}
-}
+};

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "sprucehttp_sjs",
-	"version": "1.0.8",
+	"version": "1.0.10",
 	"description": "A module for responding to requests within SpruceHTTP in an SJS file",
 	"main": "index.js",
 	"scripts": {
@@ -23,5 +23,8 @@
 		"email": "herronjo@stibarc.dev",
 		"url": "https://stibarc.dev"
 	},
-	"license": "Copyright (c) STiBaRC LLC. All rights reserved."
+	"license": "Copyright (c) STiBaRC LLC. All rights reserved.",
+	"dependencies": {
+		"sprucehttp_sjs": "file:"
+	}
 }