Always define start and stop on Service
#48
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
`Service`'s types say that `start` and `stop` can be undefined. This is impossible in practice because the only way to instantiate a `Service` is via `Registry.prototype.publish`, which always sets these properties. This small refactor avoids this problem to ensure that `start` and `stop` are always defined, which should make the library a bit easier to use.
EvanHahn
commented
Jan 22, 2024
| function start(service: Service, registry: Registry, opts?: { probe: boolean }) { | ||
| const service = new Service(config, start.bind(null, this), stop.bind(null, this)) | ||
|
|
||
| function start(registry: Registry, { probe = configProbe }: { probe?: boolean } = {}) { |
There was a problem hiding this comment.
This uses config.probe, but lets you override it per call to start() as before.
EvanHahn
added a commit
to digidem/comapeo-core
that referenced
this pull request
Feb 12, 2024
This version integrates all of our patches except the one for the `probe` option when starting a `Service`. That version also has some trickiness around types for `start` and `stop`, which are also fixed here. I submitted these patches [upstream] but haven't heard back as of this writing. [upstream]: onlxltd/bonjour-service#48
EvanHahn
added a commit
to digidem/comapeo-core
that referenced
this pull request
Feb 13, 2024
This version integrates all of our patches except the one for the `probe` option when starting a `Service`. That version also has some trickiness around types for `start` and `stop`, which are also fixed here. I submitted these patches [upstream] but haven't heard back as of this writing. [upstream]: onlxltd/bonjour-service#48
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Service's types say thatstartandstopcan be undefined. This is impossible in practice because the only way to instantiate aServiceis viaRegistry.prototype.publish, which always sets these properties.This small refactor avoids this problem to ensure that
startandstopare always defined, which should make the library a bit easier to use.