necessary 13.6.7 → 14.0.0

package/README.md

@@ -147,20 +147,10 @@ Note that the `headers` argument is not optional this time.
 
 ## Shell utilities
 
-- `onETX()`
 - `prompt()`
 
-Functions that can be used for Node applications running in a shell window.
-
-* The `onETX()` function takes a handler which is invoked whenever the `ETX` character code is encountered in the `stdin` stream, which typically happens when the user presses `Ctrl-C`. This function is therefore useful for exiting a console application immediately upon the user's behest, if it is passed `process.exit`. It also returns a function that can be called to remove the listener at some later point in time:
-
-```
-const offEXT = onEXT(process.exit);
-
-...
-
-offEXT();
-```
+Functions for applications running on a shell such as Bash or ZSH. 
+In fact there is only one currently. 
 
 * The `prompt()` function is meant for use in shell applications. It takes a plain old JavaScript `options` object and a `callback` function as its first and second arguments, respectively:
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "necessary",
   "author": "James Smith",
-  "version": "13.6.7",
+  "version": "14.0.0",
   "license": "MIT, Anti-996",
   "homepage": "https://github.com/djalbat/necessary",
   "description": "A collection of utility functions.",

package/src/utilities/shell.js

@@ -3,7 +3,6 @@
 import { whilst } from "../utilities/asynchronous";
 
 import { DATA } from "../constants";
-import { UTF8_ENCODING } from "../encodings";
 import { DEFAULT_ENCODING, DEFAULT_ATTEMPTS, DEFAULT_INITIAL_ANSWER } from "../defaults";
 import { UP_CHARACTER,
          ETX_CHARACTER,
@@ -15,33 +14,6 @@ import { UP_CHARACTER,
          BACKSPACE_CHARACTER,
          CARRIAGE_RETURN_CHARACTER } from "../characters";
 
-export function onETX(handler) {
-  if (process.stdin.setRawMode) {
-    const rawMode = true,
-          encoding = UTF8_ENCODING;
-
-    process.stdin.setRawMode(rawMode);
-
-    process.stdin.setEncoding(encoding);
-
-    process.stdin.addListener(DATA, listener);
-
-    process.stdin.resume();
-
-    return offExt;
-  }
-
-  function offExt() {
-    process.stdin.removeListener(DATA, listener);
-  }
-
-  function listener(character) {
-    if (character === ETX_CHARACTER) {
-      handler();
-    }
-  }
-}
-
 export function prompt(options, callback) {
   let { answer = null } = options;
 
@@ -66,7 +38,6 @@ export function prompt(options, callback) {
 }
 
 export default {
-  onETX,
   prompt
 }