Extension Port Stream

A module for creating a Node-style stream over a WebExtension Runtime.Port object.

Usage

import PortStream from 'extension-port-stream'

extension.runtime.onConnect.addListener(connectRemote)
const portStream = new PortStream(remotePort)

// Enjoy!

Running tests

yarn test

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Unreleased

4.2.0

Changed

• Allow overriding Duplex stream constructor options (#59)

4.1.0

Added

• Add named export of PortDuplexStream in addition to existing default export (#57)

4.0.0

Fixed

• BREAKING: webextension-polyfill is now a peer-dependency rather than a dependency. Users are expected to provide the runtime. (#54)
• webextension-polyfill import changed to type-only import (#54)

3.0.0

Changed

• BREAKING: Use portable readable-stream@^3.6.2 instead of native streams (#51)

2.1.1

Changed

• deps: replace webextension-polyfill-ts with webextension-polyfill (#43)

2.1.0 - 2023-06-15

Added

• _setLogger method can be used to inject custom logger for incoming/outgoing messages (#46)

Changed

• deps: webextension-polyfill-ts@0.22.0->0.26.0 (#37)
  • Updates webextension-polyfill from 0.7.0 to 0.8.0

Fixed

• Fix exporting of types (#24)
• deps: webextension-polyfill-ts@0.22.0->0.26.0 (#37)
  • Updates webextension-polyfill from 0.7.0 to 0.8.0

2.0.1 - 2021-04-29

Changed

• Move webextension-polyfill-ts from devDependencies to dependencies (#11)

2.0.0 - 2020-11-23

Added

• TypeScript typings (#4)

Removed

• (BREAKING) Remove readable-stream dependency (#4)
  • Consumers using this package in browser environments will have to bring their own Node.js stream polyfill.