docs: retained message config example #967
Closed
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
Covers connecting via url string, TS options obj format
Codecov ReportPatch coverage has no change and project coverage change:
Additional details and impacted files@@ Coverage Diff @@
## master #967 +/- ##
==========================================
+ Coverage 93.63% 93.73% +0.10%
==========================================
Files 8 8
Lines 942 942
Branches 249 249
==========================================
+ Hits 882 883 +1
+ Misses 60 59 -1 ☔ View full report in Codecov by Sentry. |
|
If you wish to continue with this PR please remember to change destination branch from |
robertsLando
changed the title
|
Not worth it for something that no one looked at for 3 years. |
|
@MBerka I started maintaining this PR so now I will check all issues/PR :) |
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.
Initially, ran into a TypeScript compilation problem where
{retain: true}would not compile (and provided an unhelpful "does not match the callback type" message) because it was missing theqosproperty and therefore not recognized as theIClientPublishOptionstype. Wanted to add documentation for this niche, then found that the basic examples did not say much about defining remote broker paths via URL string. Add the responsibility of clearing the retained message on the test broker, and this is is the result.Happy to adjust for clarity, or write about the TypeScript pitfall elsewhere if there is a better spot. Thanks!