Edit README #3
Merged
Edit README #3
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
pauljwil
commented
Jul 1, 2024
pauljwil
commented
Jul 1, 2024
pauljwil
commented
Jul 1, 2024
seemk
approved these changes
Jul 15, 2024
pauljwil
commented
Jul 17, 2024
pauljwil
commented
Jul 17, 2024
pauljwil
commented
Jul 17, 2024
seemk
reviewed
Jul 26, 2024
README.md
Outdated
| |--------------------------|----------|---------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------| | ||
| | `signalflowEndpoint` | string | Sets the SignalFlow endpoint. | `wss://stream.us0.signalfx.com`. If you aren't in `us0`, change the realm. | | ||
| | `apiEndpoint` | string | Sets the API endpoint. | `https://api.us0.signalfx.com`. If you aren't in `us0`, change the realm. | | ||
| | `webSocketErrorCallback` | function | Sets the callback function that is invoked when a WebSocket error occurs. | Throws the WebSocket error. You can change the behavior to invoke a callback function instead. | |
There was a problem hiding this comment.
I'd change Throws the WebSocket error. to If not set, the WebSocket error is thrown instead. (or something akin to this wording)
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.
Jira: O11YDOCS-5992
Edited the README file to improve content presentation on npmjs.com/package/signal.