sprucehttp_sjs 1.0.0 → 1.0.1

package/README.md

@@ -0,0 +1,68 @@
+# SpruceHTTP SJS:
+A module for responding to requests within SpruceHTTP in an SJS file.
+
+## Table of Contents:
+ - [Table of Contents](#table-of-contents)
+ - [Documentation](#documentation)
+ 	- [streamMode()](#streammode)
+ 	- [writeStatusLine(statusCode, reasonPhrase)](#writestatuslinestatuscode-reasonphrase)
+	- [writeHeader(name, value)](#writestatuslinestatuscode-reasonphrase)
+	- [writeData(data)](#writedatadata)
+
+## Documentation:
+Importing the module:
+```js
+const sjs = require("sprucehttp_sjs");
+```
+
+### ``streamMode()``:
+Sets the response into stream mode. This cannot be undone for the duration of the script, and should be the first action performed if this is the intended mode.
+
+Stream mode means that responses are not buffered by the webserver, and thus are sent immediately as they're received from the SJS script. This means that the status line and headers _**must**_ be sent first before the data, and the ``\r\n`` after the headers must be sent by the script as well.
+
+```js
+sjs.streamMode(); // Set the response to stream mode.
+```
+
+### ``writeStatusLine(statusCode[, reasonPhrase])``
+ - ``statusLine:`` number: The HTTP status code to send.
+ - ``reasonPhrase:`` string: The reason phrase to send.
+
+Writes the status line to the response.
+
+To send a 200 "OK" response, without needing to specify the reason phrase.
+```js
+sjs.writeStatusLine(200);
+```
+
+To send a 418 "I'm a teapot" response, with a specified reason phrase.
+```js
+sjs.writeStatusLine(418, "I'm a teapot");
+```
+
+### ``writeHeader(name, value)``
+ - ``name:`` string: The name of the header to send.
+ - ``value:`` string: The value of the header to send.
+
+Writes a header to the response.
+
+To write the "Content-Type: text/html" header.
+```js
+sjs.writeHeader("Content-Type", "text/html");
+```
+
+### ``writeData(data)``
+ - ``data:`` string | Buffer: The data to send.
+
+Writes data (the body) to the response. When not in stream mode, the Content-Length header is automatically updated.
+
+Writes text data to the body.
+```js
+sjs.writeData("Hello, world!");
+```
+
+Writes binary data (a picture, in this case) to the body.
+```js
+const fs = require('fs');
+sjs.writeData(fs.readFileSync("image.png", 'binary'));
+```

package/index.js

@@ -1,9 +1,20 @@
 module.exports = {
+	/**
+	 * Sets the response into stream mode.
+	 * 
+	 * Stream mode means that responses are not buffered by the webserver.
+	 */
 	streamMode: function() {
 		process.send({
 			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) {
 		process.send({
 			type: 'status',
@@ -11,6 +22,12 @@ module.exports = {
 			reasonPhrase
 		});
 	},
+
+	/**
+	 * Writes a header to the response.
+	 * @param {string} name The name of the header to send.
+	 * @param {string} value The value of the header to send.
+	 */
 	writeHeader: function(name, value) {
 		process.send({
 			type: 'status',
@@ -18,6 +35,13 @@ module.exports = {
 			value
 		});
 	},
+
+	/**
+	 * Writes data (the body) to the response.
+	 * 
+	 * When not in stream mode, the Content-Length header is automatically updated.
+	 * @param {string | Buffer} data The data to send.
+	 */
 	writeData: function(data) {
 		process.send({
 			type: 'data',

package/package.json

@@ -1,27 +1,27 @@
 {
-  "name": "sprucehttp_sjs",
-  "version": "1.0.0",
-  "description": "Module for responding to requests within SpruceHTTP in an SJS file",
-  "main": "index.js",
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
-  },
-  "keywords": [
+	"name": "sprucehttp_sjs",
+	"version": "1.0.1",
+	"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/",
+	"homepage": "https://stibarc.dev/spruce/",
 	"bugs": {
 		"url": "https://stibarc.dev/spruce/reportbug/",
 		"email": "herronjo@stibarc.dev"
 	},
-  "author": {
+	"author": {
 		"name": "Joshua Herron",
 		"email": "herronjo@stibarc.dev",
 		"url": "https://stibarc.dev"
 	},
-  "license": "Copyright (c) STiBaRC LLC. All rights reserved."
+	"license": "Copyright (c) STiBaRC LLC. All rights reserved."
 }