bare-ipc 1.1.2 → 1.1.3

package/README.md

@@ -27,66 +27,7 @@ b.on('data', (data) => {
 
 ## API
 
-### `IPC`
-
-#### `const [portA, portB] = IPC.open()`
-
-Returns a pair of connected `IPCPort`s for constructing the IPC duplex stream based on `bare-pipe`. Each port is transferable and can be sent to another thread or process before being connected.
-
-#### `const ipc = new IPC(port)`
-
-Returns a duplex stream using the provided `port`. See `bare-stream`'s `Duplex` (<https://github.com/holepunchto/bare-stream>) for the duplex stream API.
-
-Errors emitted by the underlying incoming or outgoing pipes are propagated to the stream as `error` events, after which the stream is destroyed.
-
-#### `ipc.incoming`
-
-The underlying `bare-pipe` `Pipe` used for reading. Read-only.
-
-#### `ipc.outgoing`
-
-The underlying `bare-pipe` `Pipe` used for writing. Read-only.
-
-#### `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()` for the common pattern to keep the event loop alive.
-
-### `IPCPort`
-
-#### `const port = new IPCPort(incoming, outgoing)`
-
-Constructs a port from a pair of file handles. The arguments are:
-
-- `incoming` is the read file handle.
-- `outgoing` is the write file handle.
-
-#### `port.connect()`
-
-Returns an `IPC` connected to the `port` and marks the `port` as detached.
-
-#### `port.incoming`
-
-The read file handle. Read-only.
-
-#### `port.outgoing`
-
-The write file handle. Read-only.
-
-#### `port.detached`
-
-A boolean for whether the `port` is detached. A port becomes detached once it is connected or transferred, and a detached port cannot be transferred again.
+See the [`bare-ipc` reference](https://docs.pears.com/reference/bare/modules/bare-ipc).
 
 ## License
 

package/index.d.ts

@@ -3,26 +3,49 @@ import Pipe from 'bare-pipe'
 import { Transferable, symbols } from 'bare-structured-clone'
 
 interface IPC extends Duplex {
+  /** The underlying `bare-pipe` `Pipe` used for reading. Read-only. */
   readonly incoming: Pipe
+  /** The underlying `bare-pipe` `Pipe` used for writing. Read-only. */
   readonly outgoing: Pipe
 
+  /** Increase the reference count for the IPC to keep the event loop alive. */
   ref(): this
+  /** Decrease the reference count for the IPC to allow the event loop to exit. */
   unref(): this
 }
 
 declare class IPC {
+  /**
+   * Returns a duplex stream using the provided `port`. See `bare-stream`'s `Duplex`
+   * (<https://github.com/holepunchto/bare-stream>) for the duplex stream API.
+   * @param port - The port to open the stream over, as returned by `IPC.open()`.
+   */
   constructor(port: IPCPort)
 }
 
 interface IPCPort extends Transferable<[incoming: number, outgoing: number]> {
+  /** The file handle used for reading. Read-only. */
   readonly incoming: number
+  /** The file handle used for writing. Read-only. */
   readonly outgoing: number
+  /**
+   * A boolean for whether the `port` is detached. A port becomes detached once it is connected or
+   * transferred, and a detached port cannot be transferred again.
+   */
   readonly detached: boolean
 
+  /**
+   * @returns An `IPC` duplex stream connected to the port.
+   */
   connect(): IPC
 }
 
 declare class IPCPort {
+  /**
+   * Constructs a port from a pair of file handles, `incoming` and `outgoing`.
+   * @param incoming - The file handle used for reading.
+   * @param outgoing - The file handle used for writing.
+   */
   constructor(incoming: number, outgoing: number)
 
   static [symbols.attach](input: [incoming: number, outgoing: number]): IPCPort
@@ -31,6 +54,12 @@ declare class IPCPort {
 declare namespace IPC {
   export { IPCPort }
 
+  /**
+   * Returns a pair of connected `IPCPort`s for constructing the IPC duplex stream based on
+   * `bare-pipe`. Each port is transferable and can be sent to another thread or process before
+   * being connected.
+   * @returns A pair of connected ports, one for each end of the IPC channel.
+   */
   export function open(): [IPCPort, IPCPort]
 }
 

package/lib/errors.d.ts

@@ -1,4 +1,10 @@
 declare class IPCError extends Error {
+  /**
+   * Create the error thrown when transferring a port that has already been connected or
+   * transferred.
+   * @param msg - The error message.
+   * @returns An error with code `ALREADY_CONNECTED`.
+   */
   static ALREADY_CONNECTED(msg: string): IPCError
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bare-ipc",
-  "version": "1.1.2",
+  "version": "1.1.3",
   "description": "Lightweight pipe-based IPC for Bare",
   "exports": {
     ".": {
@@ -36,7 +36,7 @@
   "dependencies": {
     "bare-pipe": "^4.0.0",
     "bare-stream": "^2.1.3",
-    "bare-structured-clone": "^1.4.0"
+    "bare-structured-clone": "^2.0.0"
   },
   "devDependencies": {
     "brittle": "^3.2.1",