bare-ipc 1.0.0 → 1.1.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,12 +2,9 @@ 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()
 
@@ -19,30 +16,46 @@ const IPC = module.exports = exports = class IPC extends Duplex {
     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) {
+  ref() {
+    this._incoming.ref()
+    this._outgoing.ref()
+  }
+
+  unref() {
+    this._incoming.unref()
+    this._outgoing.unref()
+  }
+
+  _read() {
+    this._incoming.resume()
+  }
+
+  _write(chunk, encoding, cb) {
     if (this._outgoing.write(chunk)) cb(null)
     else this._pendingWrite = cb
   }
 
-  _final (cb) {
+  _final(cb) {
     this._outgoing.end()
     cb(null)
   }
 
-  _ondata (data) {
-    this.push(data)
+  _ondata(data) {
+    if (this.push(data) === false) {
+      this._incoming.pause()
+    }
   }
 
-  _onend () {
+  _onend() {
     this.push(null)
   }
 
-  _ondrain () {
+  _ondrain() {
     if (this._pendingWrite === null) return
     const cb = this._pendingWrite
     this._pendingWrite = null
@@ -50,22 +63,26 @@ const IPC = module.exports = exports = class IPC extends Duplex {
   }
 }
 
+const IPC = module.exports
+
 class IPCPort {
-  constructor (incoming, outgoing) {
+  constructor(incoming, outgoing) {
     this.incoming = incoming
     this.outgoing = outgoing
     this.detached = false
   }
 
-  connect () {
+  connect() {
     const ipc = new IPC(this)
     this.detached = true
     return ipc
   }
 
-  [Symbol.for('bare.detach')] () {
+  [Symbol.for('bare.detach')]() {
     if (this.detached) {
-      throw errors.ALREADY_CONNECTED('Port has already started receiving messages')
+      throw errors.ALREADY_CONNECTED(
+        'Port has already started receiving messages'
+      )
     }
 
     this.detached = true
@@ -73,17 +90,14 @@ class IPCPort {
     return [this.incoming, this.outgoing]
   }
 
-  static [Symbol.for('bare.attach')] ([incoming, outgoing]) {
+  static [Symbol.for('bare.attach')]([incoming, outgoing]) {
     return new this(incoming, outgoing)
   }
 }
 
-exports.open = function open (opts) {
+exports.open = function open(opts) {
   const a = Pipe.pipe(opts)
   const b = Pipe.pipe(opts)
 
-  return [
-    new IPCPort(a[0], b[1], opts),
-    new IPCPort(b[0], a[1], opts)
-  ]
+  return [new IPCPort(a[0], b[1], opts), new IPCPort(b[0], a[1], opts)]
 }

package/lib/errors.d.ts

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

package/lib/errors.js

@@ -1,5 +1,5 @@
 module.exports = class IPCError extends Error {
-  constructor (msg, code, fn = IPCError) {
+  constructor(msg, code, fn = IPCError) {
     super(`${code}: ${msg}`)
     this.code = code
 
@@ -8,11 +8,11 @@ module.exports = class IPCError extends Error {
     }
   }
 
-  get name () {
+  get name() {
     return 'IPCError'
   }
 
-  static ALREADY_CONNECTED (msg) {
+  static ALREADY_CONNECTED(msg) {
     return new IPCError(msg, 'ALREADY_CONNECTED', IPCError.ALREADY_CONNECTED)
   }
 }

package/package.json

@@ -1,18 +1,25 @@
 {
   "name": "bare-ipc",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "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": {
-    "test": "standard && bare test.js"
+    "test": "prettier . --check && bare test.js"
   },
   "repository": {
     "type": "git",
@@ -25,11 +32,13 @@
   },
   "homepage": "https://github.com/holepunchto/bare-ipc#readme",
   "dependencies": {
-    "bare-pipe": "^3.3.2",
-    "bare-stream": "^2.1.3"
+    "bare-pipe": "^4.0.0",
+    "bare-stream": "^2.1.3",
+    "bare-structured-clone": "^1.4.0"
   },
   "devDependencies": {
     "brittle": "^3.2.1",
-    "standard": "^17.0.0"
+    "prettier": "^3.4.1",
+    "prettier-config-standard": "^7.0.0"
   }
 }