sprucehttp_sjs 1.0.4 → 1.0.7

package/README.md

@@ -8,16 +8,19 @@ A module for responding to requests within SpruceHTTP in an SJS file.
  	- [writeStatusLine(statusCode, reasonPhrase)](#writestatuslinestatuscode-reasonphrase)
 	- [writeHeader(name, value)](#writeheadername-value)
 	- [writeData(data)](#writedatadata)
+	- [writeDataAsync(data)](#writedataasyncdata)
 	- [siteConfig()](#siteconfig)
 	- [requestIP()](#requestip)
 	- [method()](#method)
 	- [path()](#path)
+	- [pathInfo()](#pathinfo)
 	- [query()](#query)
 	- [queryValue(key)](#queryvaluekey)
 	- [httpVersion()](#httpversion)
 	- [headers()](#headers)
 	- [headerValue(name)](#headervaluename)
 	- [body()](#body)
+	- [bodyStream()](#bodystream)
 
 ## Documentation:
 Importing the module:
@@ -77,6 +80,22 @@ const fs = require('fs');
 sjs.writeData(fs.readFileSync("image.png", 'binary'));
 ```
 
+### ``writeDataAsync(data)``:
+ - ``data:`` string | Buffer: The data to send.
+
+Writes data (the body) to the response asynchronously. When not in stream mode, the Content-Length header is automatically updated.
+
+Writes text data to the body.
+```js
+await sjs.writeDataAsync("Hello, world!");
+```
+
+Writes binary data (a picture, in this case) to the body.
+```js
+const fs = require('fs');
+await sjs.writeDataAsync(fs.readFileSync("image.png", 'binary'));
+```
+
 ### ``siteConfig()``:
 Returns the site-specific configuration set in your config file.
 
@@ -126,6 +145,17 @@ console.log(sjs.path());
 // /index.sjs
 ```
 
+### ``pathInfo()``:
+Returns the request's info path.
+
+```js
+// Using path /index.sjs/info
+console.log(sjs.path());
+console.log(sjs.pathInfo());
+// /index.sjs
+// /info
+```
+
 ### ``query()``:
 Returns the request query.
 
@@ -188,4 +218,12 @@ Returns the request body as a buffer.
 ```js
 console.log(sjs.body().toString("utf8"));
 // Hello, world!
+```
+
+### ``bodyStream()``:
+Returns the request body as a buffer.
+
+```js
+console.log(sjs.bodyStream().read(13).toString("utf8"));
+// Hello, world!
 ```

package/index.js

@@ -45,9 +45,21 @@ module.exports = {
 	 * @param {string | Buffer} data The data to send.
 	 */
 	writeData: function(data) {
-		process.send({
-			type: 'data',
-			data: Buffer.from(data).toString('base64')
+		(async () => {await this.writeDataAsync(data);})();
+	},
+
+	/**
+	 * Writes data (the body) to the response asynchronously.
+	 * 
+	 * 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) {
+			process.send({
+				type: 'data',
+				data: Buffer.from(data)
+			}, resolve);
 		});
 	},
 
@@ -87,6 +99,15 @@ module.exports = {
 		return process.env.reqPath;
 	},
 
+	/**
+	 * Returns the request's info path.
+	 * 
+	 * @returns {string} The request's info path.
+	 */
+	pathInfo: function() {
+		return process.env.reqPathInfo;
+	},
+
 	/**
 	 * Returns the parsed query string of the request.
 	 * 
@@ -140,6 +161,24 @@ module.exports = {
 	 * @returns {Buffer} The body of the request.
 	 */
 	body: function() {
-		return fs.readFileSync(process.env.reqBody, 'binary');
+		let retVal = undefined;
+		if (process.env.reqBody) {
+			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.4",
-	"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.7",
+	"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."
+}