bare-ipc 1.0.1 → 1.1.1

package/README.md

@@ -6,6 +6,53 @@ Lightweight pipe-based IPC for Bare.
 npm i bare-ipc
 ```
 
+## API
+
+### `IPC`
+
+#### `const [portA, portB] = IPC.open(opts)`
+
+Returns a pair of `IPCPort`s for use constructing the IPC duplex stream based on
+`bare-pipe`.
+
+#### `const ipc = new IPC(port)`
+
+Returns a duplex stream using the provided port. See `streamx`'s [`Duplex`](https://github.com/mafintosh/streamx?tab=readme-ov-file#duplex-stream) for Duplex API.
+
+#### `ipc.ref()`
+
+Increase the reference count for the IPC to keep the event loop alive.
+
+A common pattern is to `ipc.ref()` on `Bare.on('resume')` and `ipc.unref()` on
+suspend like so:
+
+```js
+Bare.on('suspend', () => ipc.unref()).on('resume', () => ipc.ref())
+```
+
+#### `ipc.unref()`
+
+Decrease the reference count for the IPC to allow the event loop to exit.
+
+See [`ipc.ref()`](#ipcref) for common pattern to keep the event loop alive.
+
+### `IPCPort`
+
+#### `const port = new IPCPort(incoming, outgoing)`
+
+The arguments are:
+
+- `incoming` is the read file handle
+- `outgoing` is the write file handle
+
+#### `port.connect()`
+
+Returns an `IPC` connected to the `port`.
+
+#### `port.detached`
+
+A boolean for whether the `port` is detached.
+
 ## License
 
 Apache-2.0

package/index.d.ts

@@ -0,0 +1,33 @@
+import { Duplex } from 'bare-stream'
+import { Transferable, symbols } from 'bare-structured-clone'
+
+interface IPC extends Duplex {
+  ref(): this
+  unref(): this
+}
+
+declare class IPC {
+  constructor(port: IPCPort)
+}
+
+interface IPCPort extends Transferable<[incoming: number, outgoing: number]> {
+  readonly incoming: number
+  readonly outgoing: number
+  readonly detached: boolean
+
+  connect(): IPC
+}
+
+declare class IPCPort {
+  constructor(incoming: number, outgoing: number)
+
+  static [symbols.attach](input: [incoming: number, outgoing: number]): IPCPort
+}
+
+declare namespace IPC {
+  export { IPCPort }
+
+  export function open(): [IPCPort, IPCPort]
+}
+
+export = IPC

package/index.js

@@ -2,52 +2,73 @@ const Pipe = require('bare-pipe')
 const { Duplex } = require('bare-stream')
 const errors = require('./lib/errors')
 
-const IPC =
-  (module.exports =
-  exports =
-    class IPC extends Duplex {
-      constructor(port) {
-        const { incoming, outgoing } = port
+module.exports = exports = class IPC extends Duplex {
+  constructor(port) {
+    const { incoming, outgoing } = port
 
-        super()
+    super()
 
-        this._incoming = new Pipe(incoming)
-        this._outgoing = new Pipe(outgoing)
+    this._incoming = new Pipe(incoming)
+    this._outgoing = new Pipe(outgoing)
 
-        this._pendingWrite = null
+    this._pendingWrite = null
 
-        this._incoming
-          .on('data', this._ondata.bind(this))
-          .on('end', this._onend.bind(this))
+    this._incoming
+      .on('data', this._ondata.bind(this))
+      .on('end', this._onend.bind(this))
+      .pause()
 
-        this._outgoing.on('drain', this._ondrain.bind(this))
-      }
+    this._outgoing.on('drain', this._ondrain.bind(this))
+  }
 
-      _write(chunk, encoding, cb) {
-        if (this._outgoing.write(chunk)) cb(null)
-        else this._pendingWrite = cb
-      }
+  ref() {
+    this._incoming.ref()
+    this._outgoing.ref()
+  }
 
-      _final(cb) {
-        this._outgoing.end()
-        cb(null)
-      }
+  unref() {
+    this._incoming.unref()
+    this._outgoing.unref()
+  }
 
-      _ondata(data) {
-        this.push(data)
-      }
+  _read() {
+    this._incoming.resume()
+  }
 
-      _onend() {
-        this.push(null)
-      }
+  _write(chunk, encoding, cb) {
+    if (this._outgoing.write(chunk)) cb(null)
+    else this._pendingWrite = cb
+  }
+
+  _final(cb) {
+    this._outgoing.end()
+    cb(null)
+  }
+
+  _predestroy() {
+    this._incoming.destroy()
+    this._outgoing.destroy()
+  }
+
+  _ondata(data) {
+    if (this.push(data) === false) {
+      this._incoming.pause()
+    }
+  }
+
+  _onend() {
+    this.push(null)
+  }
+
+  _ondrain() {
+    if (this._pendingWrite === null) return
+    const cb = this._pendingWrite
+    this._pendingWrite = null
+    cb(null)
+  }
+}
 
-      _ondrain() {
-        if (this._pendingWrite === null) return
-        const cb = this._pendingWrite
-        this._pendingWrite = null
-        cb(null)
-      }
-    })
+const IPC = module.exports
 
 class IPCPort {
   constructor(incoming, outgoing) {
@@ -79,9 +100,9 @@ class IPCPort {
   }
 }
 
-exports.open = function open(opts) {
-  const a = Pipe.pipe(opts)
-  const b = Pipe.pipe(opts)
+exports.open = function open() {
+  const a = Pipe.pipe()
+  const b = Pipe.pipe()
 
-  return [new IPCPort(a[0], b[1], opts), new IPCPort(b[0], a[1], opts)]
+  return [new IPCPort(a[0], b[1]), new IPCPort(b[0], a[1])]
 }

package/lib/errors.d.ts

@@ -0,0 +1,5 @@
+declare class IPCError extends Error {
+  static ALREADY_CONNECTED(msg: string): IPCError
+}
+
+export = IPCError

package/package.json

@@ -1,14 +1,21 @@
 {
   "name": "bare-ipc",
-  "version": "1.0.1",
+  "version": "1.1.1",
   "description": "Lightweight pipe-based IPC for Bare",
   "exports": {
-    ".": "./index.js",
+    ".": {
+      "types": "./index.d.ts",
+      "default": "./index.js"
+    },
     "./package": "./package.json",
-    "./errors": "./lib/errors.js"
+    "./errors": {
+      "types": "./lib/errors.d.ts",
+      "default": "./lib/errors.js"
+    }
   },
   "files": [
     "index.js",
+    "index.d.ts",
     "lib"
   ],
   "scripts": {
@@ -26,7 +33,8 @@
   "homepage": "https://github.com/holepunchto/bare-ipc#readme",
   "dependencies": {
     "bare-pipe": "^4.0.0",
-    "bare-stream": "^2.1.3"
+    "bare-stream": "^2.1.3",
+    "bare-structured-clone": "^1.4.0"
   },
   "devDependencies": {
     "brittle": "^3.2.1",