bare-tty 5.2.0 → 5.2.2

package/README.md

@@ -16,6 +16,10 @@ const stdout = new tty.WriteStream(1)
 stdout.write('Hello world!\n')
 ```
 
+## API
+
+See the [`bare-tty` reference](https://docs.pears.com/reference/bare/modules/bare-tty).
+
 ## License
 
 Apache-2.0

package/binding.c

@@ -557,6 +557,7 @@ bare_tty_exports(js_env_t *env, js_value_t *exports) {
 
   V("MODE_NORMAL", UV_TTY_MODE_NORMAL)
   V("MODE_RAW", UV_TTY_MODE_RAW)
+  V("MODE_RAW_VT", UV_TTY_MODE_RAW_VT)
 #ifndef _WIN32
   V("MODE_IO", UV_TTY_MODE_IO)
 #endif

package/index.d.ts

@@ -7,14 +7,22 @@ interface ReadStreamOptions extends ReadableOptions {
 }
 
 interface ReadStream extends Readable {
+  /** The stream's underlying file descriptor. */
   readonly fd: number
+  /** Always `true`, identifying the stream as a TTY. */
   readonly isTTY: true
 
+  /** Set the TTY mode directly, using one of the `constants.mode` values. Returns the stream. */
   setMode(mode: number): this
+  /**
+   * Enable or disable raw mode. In raw mode, input is delivered byte-by-byte without line buffering
+   * or special key processing. Returns the stream.
+   */
   setRawMode(mode: boolean): this
 }
 
 declare class ReadStream extends Readable {
+  /** Create a `ReadStream` for the TTY file descriptor `fd`. */
   constructor(fd: number, opts?: ReadStreamOptions)
 }
 
@@ -23,18 +31,28 @@ interface WriteStreamEvents extends WritableEvents {
 }
 
 interface WriteStream<M extends WriteStreamEvents = WriteStreamEvents> extends Writable<M> {
+  /** The stream's underlying file descriptor. */
   readonly fd: number
+  /** Always `true`, identifying the stream as a TTY. */
   readonly isTTY: true
+  /** The current number of columns in the TTY. */
   readonly columns: number
+  /** The current number of rows in the TTY. */
   readonly rows: number
 
+  /** Return the current TTY dimensions as `[width, height]`. */
   getWindowSize(): [width: number, height: number]
 }
 
 declare class WriteStream<M extends WriteStreamEvents = WriteStreamEvents> extends Writable<M> {
+  /** Create a `WriteStream` for the TTY file descriptor `fd`. */
   constructor(fd: number, opts?: WritableOptions)
 }
 
+/**
+ * Return whether `fd` refers to a TTY.
+ * @param fd - The file descriptor to check.
+ */
 declare function isTTY(fd: number): boolean
 
 export {

package/index.js

@@ -6,7 +6,12 @@ const errors = require('./lib/errors')
 
 const defaultReadBufferSize = 65536
 const empty = Buffer.alloc(0)
-const modes = new Set([constants.mode.NORMAL, constants.mode.RAW, constants.mode.IO])
+const modes = new Set([
+  constants.mode.NORMAL,
+  constants.mode.RAW,
+  constants.mode.RAW_VT,
+  constants.mode.IO
+])
 
 exports.ReadStream = class TTYReadStream extends Readable {
   constructor(fd, opts = {}) {
@@ -45,7 +50,7 @@ exports.ReadStream = class TTYReadStream extends Readable {
   }
 
   setRawMode(enabled) {
-    return this.setMode(enabled ? constants.mode.RAW : constants.mode.NORMAL)
+    return this.setMode(enabled ? constants.mode.RAW_VT : constants.mode.NORMAL)
   }
 
   _alive() {
@@ -99,7 +104,10 @@ exports.ReadStream = class TTYReadStream extends Readable {
       return
     }
 
-    const copy = Buffer.allocUnsafe(read)
+    // Unpooled, as a read too small to be given a buffer of its own would
+    // otherwise pin the whole pool it came from for as long as its consumer
+    // holds on to it.
+    const copy = Buffer.allocUnsafeSlow(read)
     copy.set(this._buffer.subarray(0, read))
 
     if (this.push(copy) === false && this.destroying === false) {

package/lib/constants.d.ts

@@ -1,5 +1,9 @@
+/**
+ * Native mode and internal state flags used by `ReadStream`/`WriteStream`, such as `mode.NORMAL`
+ * and `mode.RAW`.
+ */
 declare const constants: {
-  mode: { NORMAL: number; RAW: number; IO: number }
+  mode: { NORMAL: number; RAW: number; RAW_VT: number; IO: number }
   state: { READING: number; CLOSING: number; CLOSED: number }
 }
 

package/lib/constants.js

@@ -4,6 +4,7 @@ module.exports = exports = {
   mode: {
     NORMAL: binding.MODE_NORMAL,
     RAW: binding.MODE_RAW,
+    RAW_VT: binding.MODE_RAW_VT,
     IO: binding.MODE_IO || 0
   },
 
@@ -18,5 +19,7 @@ module.exports = exports = {
 exports.MODE_NORMAL = exports.mode.NORMAL
 /** @deprecated Use `mode.RAW` */
 exports.MODE_RAW = exports.mode.RAW
+/** @deprecated Use `mode.RAW_VT` */
+exports.MODE_RAW_VT = exports.mode.RAW_VT
 /** @deprecated Use `mode.IO` */
 exports.MODE_IO = exports.mode.IO

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bare-tty",
-  "version": "5.2.0",
+  "version": "5.2.2",
   "description": "Native TTY streams for JavaScript",
   "exports": {
     "./package": "./package.json",