@tvkitchen/base-interfaces

This package exports interfaces that define the shape of modular architectural components of TV Kitchen.

See the @tvkitchen/base README for more information.

Install

Using Yarn:

yarn add @tvkitchen/base-interfaces

or using npm:

npm install @tvkitchen/base-interfaces

Changelog for @tvkitchen/base-interfaces

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.0.0-alpha.5 - 2022-03-04

Added

• Package now specifies Node 16.x or above.

Fixed

• Fixed a bug where stream callback was being called by NodeJS directly, resulting in duplicate callback errors (Issue #124)

4.0.0-alpha.4 - 2021-04-16

Changed

• IAppliance class methods are no longer properties / arrow functions.

4.0.0-alpha.3

Removed

• IAppliance no longer has a functioning logger, just a reference to the need for a logger.

Changed

• IAppliance now extends NodeJS's stream.Transform, which means Appliances function as streams instead of simple event emitters.

4.0.0-alpha.2

Changed

• Renamed setup to start and changed its return type.
• Renamed teardown to stop and changed its return type.

4.0.0-alpha.1

Changed

• Updated the minimum version of @tvkitchen/base-constants to 1.1.1.
• Removed the unnecessarily required emitResult method from IAppliance.
• Made the IAppliance getInputTypes and getOutputTypes methods static.

Added

• Create isIAppliance duck type method to IAppliance.

3.0.0 - 2020-06-23

Changed

• audit method turned to an async method.

2.0.0 - 2020-06-23

Changed

• invoke (IAppliance) to consume a PayloadArray.
• invoke (IAppliance) to return a PayloadArray.

Added

• audit method to IAppliance.
• setup and teardown abstract methods to IAppliance.
• logger to the IAppliance API.

1.0.1 - 2020-06-05

Changed

• Improved package description.

1.0.0 - 2020-05-27

Added

• IAppliance core interface.
• Initial setup.