bare-ipc 1.1.0 → 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.js

@@ -45,6 +45,11 @@ module.exports = exports = class IPC extends Duplex {
     cb(null)
   }
 
+  _predestroy() {
+    this._incoming.destroy()
+    this._outgoing.destroy()
+  }
+
   _ondata(data) {
     if (this.push(data) === false) {
       this._incoming.pause()
@@ -95,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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bare-ipc",
-  "version": "1.1.0",
+  "version": "1.1.1",
   "description": "Lightweight pipe-based IPC for Bare",
   "exports": {
     ".": {