CHANGELOG

Versioning

This library is versioned based on Semantic Versioning (SemVer).

The scope of what is covered by the version number excludes:

error messages; the text of the messages can change, unless specifically documented.

create a release branch
update the changelog below
update version and copyright-years in ./LICENSE.md and ./src/mediator2/init.lua (in doc-comments header, and in module constants)
create a new rockspec and update the version inside the new rockspec:
cp mediator2-dev-1.rockspec ./rockspecs/mediator2-X.Y.Z-1.rockspec
test: run make test and make lint
render the docs: run make docs
commit the changes as release X.Y.Z
push the commit, and create a release PR
after merging tag the release commit with vX.Y.Z
upload to LuaRocks:
luarocks upload ./rockspecs/mediator2-X.Y.Z-1.rockspec --api-key=ABCDEFGH
test the newly created rock:
luarocks install mediator2

Forked from the Olivine-Labs original
fix: ci moved to Github Actions
fix: linter errors
fix: priority cannot be 0, since Lua arrays start at 1
fix: set 'channel' property on subscriber, drop 'stopped' as it was unused
fix: use proper 'self' instead of upvalue in channel
feat: add ldoc based documentation
feat: allow Subscriber to update its priority
BREAKING: remove the exported Channel and Subscriber functions.
feat: add "remove" method to Subscriber to unsubscribe
BREAKING: remove the subscriber id, instead use subscriber object itself. Several methods changed signature or were removed.
BREAKING: changed the result of the callbacks, default is now to continue processing instead of stopping. 2 signals, mediator.STOP and mediator.CONTINUE can be returned.
BREAKING feat: add a context (ctx) to a subscriber that is passed as the first argument on each publish call, which also enables object-based handlers.
BREAKING: renamed mediator:subscribe to mediator:addSubscriber for consistency.
fix: addChannel no longer overwrites the existing one if it exists
feat: added an option for a subscriber to specify to NOT receive child messages
feat: added Channel:getNamespaces to retrieve namespace array of channel
feat: added WILDCARD, to match any namespace when subscribing