sprucehttp_sjs 1.0.6 → 1.0.9

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)
@@ -20,6 +21,7 @@ A module for responding to requests within SpruceHTTP in an SJS file.
 	- [headers()](#headers)
 	- [headerValue(name)](#headervaluename)
 	- [body()](#body)
+	- [bodyStream()](#bodystream)
 
 ## Documentation:
 Importing the module:
@@ -95,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.
 
@@ -217,4 +237,12 @@ Returns the request body as a buffer.
 ```js
 console.log(sjs.body().toString("utf8"));
 // Hello, world!
+```
+
+### ``bodyStream()``:
+Returns the request body as a ReadStream.
+
+```js
+console.log(sjs.bodyStream().read(13).toString("utf8"));
+// Hello, world!
 ```

package/index.js

@@ -63,6 +63,18 @@ module.exports = {
 		});
 	},
 
+	/**
+	 * 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.
 	 * 
@@ -166,5 +178,19 @@ module.exports = {
 			retVal = fs.readFileSync(process.env.reqBody);
 		}
 		return retVal;
+	},
+
+	/**
+	 * Returns the body of the request as an fs.ReadStream.
+	 * 
+	 * @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) {
+		let retVal = undefined;
+		if (process.env.reqBody) {
+			retVal = fs.createReadStream(process.env.reqBody, options);
+		}
+		return retVal;
 	}
 }

package/package.json

@@ -1,27 +1,27 @@
-{
-	"name": "sprucehttp_sjs",
-	"version": "1.0.6",
-	"description": "A module for responding to requests within SpruceHTTP in an SJS file",
-	"main": "index.js",
-	"scripts": {
-		"test": "echo \"Error: no test specified\" && exit 1"
-	},
-	"keywords": [
-		"http",
-		"server",
-		"https",
-		"spruce",
-		"sprucehttp"
-	],
-	"homepage": "https://stibarc.dev/spruce/",
-	"bugs": {
-		"url": "https://stibarc.dev/spruce/reportbug/",
-		"email": "herronjo@stibarc.dev"
-	},
-	"author": {
-		"name": "Joshua Herron",
-		"email": "herronjo@stibarc.dev",
-		"url": "https://stibarc.dev"
-	},
-	"license": "Copyright (c) STiBaRC LLC. All rights reserved."
-}
+{
+	"name": "sprucehttp_sjs",
+	"version": "1.0.9",
+	"description": "A module for responding to requests within SpruceHTTP in an SJS file",
+	"main": "index.js",
+	"scripts": {
+		"test": "echo \"Error: no test specified\" && exit 1"
+	},
+	"keywords": [
+		"http",
+		"server",
+		"https",
+		"spruce",
+		"sprucehttp"
+	],
+	"homepage": "https://stibarc.dev/spruce/",
+	"bugs": {
+		"url": "https://stibarc.dev/spruce/reportbug/",
+		"email": "herronjo@stibarc.dev"
+	},
+	"author": {
+		"name": "Joshua Herron",
+		"email": "herronjo@stibarc.dev",
+		"url": "https://stibarc.dev"
+	},
+	"license": "Copyright (c) STiBaRC LLC. All rights reserved."
+}