chore: improve Listener signature #1826
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Improved Listener signature so it can accept callback or promise.
Addresses https://github.com/strongloop/loopback-next/pull/4730/files#r385912758, required for landing PR loopbackio/loopback-next#4730.
The
observe
andremoveObserver
methods of a class implementingObserverMixin
can accept a callback or a promise. The current typing does not allow that. This PR re-defines theListener
type to be either a callback that returnsvoid
or a promise that resolves tovoid
.The problem this PR solves manifests only in TS projects, like LB next, hence it cannot be tested in the Juggler repository.
Before settling on this change, we tried another approach:
but the overloaded interfaced did not work as expected.
Checklist
👉 Read and sign the CLA (Contributor License Agreement) 👈
npm test
passes on your machine